simple-process

Wrapper to simplify working with external processes.

This project is at an early development stage and the API will change without backwards compatibility.

• Changelog
• API JavaDoc
• Test report
• Coverage report

Usage

This project requires Java 17 or later.

Add Dependency

Add dependency to your Gradle project:

dependencies {
    implementation 'org.itsallcode:simple-process:0.1.0'
}

Add dependency to your Maven project:

<dependency>
  <groupId>org.itsallcode</groupId>
  <artifactId>simple-process</artifactId>
  <version>0.1.0</version>
</dependency>

Features

Simplified API for starting external processes and executable JARs. Allows easy capturing stdout and stderr and forwarding to log output.

Development

Check if dependencies are up-to-date

./gradlew dependencyUpdates

Building

Install to local maven repository:

./gradlew publishToMavenLocal

Test Coverage

To calculate and view test coverage:

./gradlew check jacocoTestReport
open build/reports/jacoco/test/html/index.html

View Generated Javadoc

./gradlew javadoc
open build/docs/javadoc/index.html

Publish to Maven Central

Preparations

1. Checkout the main branch, create a new branch.
2. Update version number in build.gradle and README.md.
3. Add changes in new version to CHANGELOG.md.
4. Commit and push changes.
5. Create a new pull request, have it reviewed and merged to main.

Perform the Release

1. Start the release workflow

• Run command gh workflow run release.yml --repo itsallcode/simple-process --ref main
• or go to GitHub Actions and start the release.yml workflow on branch main.

2. Update title and description of the newly created GitHub release.
3. After some time the release will be available at Maven Central.