diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b1db881a..0c7cece8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -57,10 +57,10 @@ jobs: - name: Publish to Maven Central Repository if: ${{ !inputs.skip-deploy-maven-central }} run: | - mvn --batch-mode deploy -Pcentral-publishing \ - -DskipPublishing=false \ - -DautoPublish=${{ inputs.maven-central-auto-publish }} \ - -DdeploymentName="Auto-deploy OFT via release.yml" + mvn --batch-mode deploy -PcentralPublishing \ + -DcentralPublishingSkipPublishing=false \ + -DcentralPublishingAutoPublish=${{ inputs.maven-central-auto-publish }} \ + -DcentralPublishingDeploymentName="Auto-deploy OpenFastTrace via release.yml" env: MAVEN_USERNAME: ${{ secrets.MAVEN_CENTRAL_PORTAL_USERNAME }} MAVEN_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PORTAL_TOKEN }} diff --git a/README.md b/README.md index ddf2e1cf..a4c2783d 100644 --- a/README.md +++ b/README.md @@ -98,7 +98,7 @@ If you just want to run OFT: The most basic variant to run OpenFastTrace is directly from the JAR file via the command line: -```bash +```sh java -jar product/target/openfasttrace-4.2.0.jar trace /path/to/directory/being/traced ``` diff --git a/doc/developer_guide.md b/doc/developer_guide.md index 54f4a043..f5b2ea36 100644 --- a/doc/developer_guide.md +++ b/doc/developer_guide.md @@ -58,7 +58,7 @@ If you want to build OFT: ## Configure Maven Toolchains -OFT uses Maven Toolchains to configure the correct JDK version (see the [documentation](https://maven.apache.org/guides/mini/guide-using-toolchains.html) for details). To configure the Toolchains plugin create file ` ~/.m2/toolchains.xml` with the following content. Adapt the paths to your JDKs. +OFT uses Maven Toolchains to configure the correct JDK version (see the [documentation](https://maven.apache.org/guides/mini/guide-using-toolchains.html) for details). To configure the Toolchains plugin create file `~/.m2/toolchains.xml` with the following content. Adapt the paths to your JDKs. ```xml /usr/lib/jvm/java-17-openjdk-amd64/ - + jdk 21 @@ -155,7 +155,7 @@ If you use a different IDE like IntelliJ, please import the formatter configurat We use [`java.util.logging`](https://docs.oracle.com/javase/8/docs/technotes/guides/logging/overview.html) for logging. To configure log level and formatting, add the following system property: -```bash +```sh -Djava.util.logging.config.file=src/test/resources/logging.properties ``` @@ -163,19 +163,19 @@ We use [`java.util.logging`](https://docs.oracle.com/javase/8/docs/technotes/gui Display dependencies and plugins with newer versions: -```bash +```sh mvn --update-snapshots versions:display-dependency-updates versions:display-plugin-updates ``` Automatically upgrade dependencies: -```bash +```sh mvn -T 1C --update-snapshots versions:use-latest-releases versions:update-properties ``` ## Run local sonar analysis -```bash +```sh mvn -T 1C clean org.jacoco:jacoco-maven-plugin:prepare-agent package sonar:sonar \ -Dsonar.token=[token] ``` @@ -187,11 +187,11 @@ See analysis results at [sonarcloud.io](https://sonarcloud.io/dashboard?id=org.i This project is configured to produce exactly the same artifacts each time when building from the same Git commit. See the [Maven Guide to Configuring for Reproducible Builds](https://maven.apache.org/guides/mini/guide-reproducible-builds.html). * Verify correct configuration of the reproducible build (also included in phase `verify`): - ```bash + ```sh mvn initialize artifact:check-buildplan ``` * Verify that the build produces exactly the same artifacts: - ```bash + ```sh mvn -T 1C clean install -DskipTests mvn -T 1C clean verify artifact:compare -DskipTests ``` @@ -275,7 +275,7 @@ This structure ensures that only user-facing components are published to Maven C Build deployment bundle to check if the expected modules are included: ```sh -mvn -T1C deploy -Pcentral-publishing -DskipPublishing=true -DskipTests +mvn -T1C deploy -PcentralPublishing -DcentralPublishingSkipPublishing=true -DskipTests ``` This will build `central-bundle.zip` in one of the modules. Find it with `find . -name "central-bundle.zip"`, then check it's content with `unzip -l api/target/central-publishing/central-bundle.zip`. @@ -296,13 +296,12 @@ Configure Maven Central credentials in `~/.m2/settings.xml`: - ``` The following command will upload the bundle to Maven Central without publishing: ```sh -mvn -T1C clean deploy -Pcentral-publishing -DskipPublishing=true -DautoPublish=false -DskipTests +mvn -T1C clean deploy -PcentralPublishing -DcentralPublishingSkipPublishing=true -DcentralPublishingAutoPublish=false -DskipTests ``` Then go to https://central.sonatype.com/publishing/deployments and check that the deployment is marked as "validated" and that the expected components are included. Don't forget to click the "Drop" button to avoid accidentally publishing the release. diff --git a/doc/user_guide.md b/doc/user_guide.md index 11a43093..47f62dce 100644 --- a/doc/user_guide.md +++ b/doc/user_guide.md @@ -889,7 +889,7 @@ exports all relevant collected information into a single XML file that can furth The XML exporter is called `aspec` reporter. `aspec` in this case means augmented specobject. An `aspec` report can be generated by calling OpenFastTrace in the following way: -```bash +```sh java -jar openfasttrace.jar trace -o aspec -f requirements.xml requirements ``` diff --git a/openfasttrace-mc-deployable-parent/pom.xml b/openfasttrace-mc-deployable-parent/pom.xml index 1cea1724..4de7d681 100644 --- a/openfasttrace-mc-deployable-parent/pom.xml +++ b/openfasttrace-mc-deployable-parent/pom.xml @@ -25,9 +25,14 @@ It is maintained separately from the main parent POM for the following reasons: Free requirement tracking suite https://github.com/itsallcode/openfasttrace + + false + false + Manual deployment of OpenFastTrace + - central-publishing + centralPublishing @@ -37,10 +42,10 @@ It is maintained separately from the main parent POM for the following reasons: true central - false - false + ${centralPublishingSkipPublishing} + ${centralPublishingAutoPublish} validated - Manual deployment of OpenFastTrace + ${centralPublishingDeploymentName}