From f8600258839d3eb3ebffba9472518bd661e6145f Mon Sep 17 00:00:00 2001 From: kaklakariada Date: Thu, 5 Feb 2026 10:12:17 +0800 Subject: [PATCH 1/6] Rename central publishing properties --- .github/workflows/release.yml | 6 +++--- doc/developer_guide.md | 4 ++-- openfasttrace-mc-deployable-parent/pom.xml | 11 ++++++++--- 3 files changed, 13 insertions(+), 8 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index b1db881a..1ab932ac 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -58,9 +58,9 @@ jobs: 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" + -DcentralPublishingSkipPublishing=false \ + -DcentralPublishingAutoPublish=${{ inputs.maven-central-auto-publish }} \ + -DcentralPublishingDeploymentName="Auto-deploy OFT via release.yml" env: MAVEN_USERNAME: ${{ secrets.MAVEN_CENTRAL_PORTAL_USERNAME }} MAVEN_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PORTAL_TOKEN }} diff --git a/doc/developer_guide.md b/doc/developer_guide.md index 54f4a043..f12cbd90 100644 --- a/doc/developer_guide.md +++ b/doc/developer_guide.md @@ -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 -Pcentral-publishing -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`. @@ -302,7 +302,7 @@ 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 -Pcentral-publishing -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/openfasttrace-mc-deployable-parent/pom.xml b/openfasttrace-mc-deployable-parent/pom.xml index 065f7d20..99425d38 100644 --- a/openfasttrace-mc-deployable-parent/pom.xml +++ b/openfasttrace-mc-deployable-parent/pom.xml @@ -25,6 +25,11 @@ 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 @@ -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} From b142ddf7c2b8553e79710c5ff9b1714f226c66b0 Mon Sep 17 00:00:00 2001 From: kaklakariada Date: Thu, 5 Feb 2026 10:16:50 +0800 Subject: [PATCH 2/6] Rename central publishing profile --- .github/workflows/release.yml | 2 +- doc/developer_guide.md | 4 ++-- openfasttrace-mc-deployable-parent/pom.xml | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 1ab932ac..47f55f7e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -57,7 +57,7 @@ jobs: - name: Publish to Maven Central Repository if: ${{ !inputs.skip-deploy-maven-central }} run: | - mvn --batch-mode deploy -Pcentral-publishing \ + mvn --batch-mode deploy -PcentralPublishing \ -DcentralPublishingSkipPublishing=false \ -DcentralPublishingAutoPublish=${{ inputs.maven-central-auto-publish }} \ -DcentralPublishingDeploymentName="Auto-deploy OFT via release.yml" diff --git a/doc/developer_guide.md b/doc/developer_guide.md index f12cbd90..5d86c7a0 100644 --- a/doc/developer_guide.md +++ b/doc/developer_guide.md @@ -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 -DcentralPublishingSkipPublishing=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`. @@ -302,7 +302,7 @@ 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 -DcentralPublishingSkipPublishing=true -DcentralPublishingAutoPublish=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/openfasttrace-mc-deployable-parent/pom.xml b/openfasttrace-mc-deployable-parent/pom.xml index 99425d38..6c6e047b 100644 --- a/openfasttrace-mc-deployable-parent/pom.xml +++ b/openfasttrace-mc-deployable-parent/pom.xml @@ -32,7 +32,7 @@ It is maintained separately from the main parent POM for the following reasons: - central-publishing + centralPublishing From db3ea695a566680824dd69f24b3dd16b1b7cefe1 Mon Sep 17 00:00:00 2001 From: kaklakariada Date: Thu, 5 Feb 2026 10:17:02 +0800 Subject: [PATCH 3/6] Fix formatting --- doc/developer_guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/doc/developer_guide.md b/doc/developer_guide.md index 5d86c7a0..990ff215 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 From 3f4699c1751e357efd60eab65710363d04c98c81 Mon Sep 17 00:00:00 2001 From: kaklakariada Date: Thu, 5 Feb 2026 10:55:30 +0800 Subject: [PATCH 4/6] Update deployment name --- .github/workflows/release.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 47f55f7e..0c7cece8 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -60,7 +60,7 @@ jobs: mvn --batch-mode deploy -PcentralPublishing \ -DcentralPublishingSkipPublishing=false \ -DcentralPublishingAutoPublish=${{ inputs.maven-central-auto-publish }} \ - -DcentralPublishingDeploymentName="Auto-deploy OFT via release.yml" + -DcentralPublishingDeploymentName="Auto-deploy OpenFastTrace via release.yml" env: MAVEN_USERNAME: ${{ secrets.MAVEN_CENTRAL_PORTAL_USERNAME }} MAVEN_PASSWORD: ${{ secrets.MAVEN_CENTRAL_PORTAL_TOKEN }} From d8e8078cf36eb8ea96cf3d71596652f8e2790d89 Mon Sep 17 00:00:00 2001 From: kaklakariada Date: Thu, 5 Feb 2026 11:28:20 +0800 Subject: [PATCH 5/6] Fix formatting --- doc/developer_guide.md | 1 - 1 file changed, 1 deletion(-) diff --git a/doc/developer_guide.md b/doc/developer_guide.md index 990ff215..85348dfe 100644 --- a/doc/developer_guide.md +++ b/doc/developer_guide.md @@ -296,7 +296,6 @@ Configure Maven Central credentials in `~/.m2/settings.xml`: - ``` The following command will upload the bundle to Maven Central without publishing: From f16a3d058a0fbd5cad44b85e3a98e52f717f65fe Mon Sep 17 00:00:00 2001 From: kaklakariada Date: Thu, 5 Feb 2026 11:29:54 +0800 Subject: [PATCH 6/6] Change shell code snippet from bash to sh --- README.md | 2 +- doc/developer_guide.md | 12 ++++++------ doc/user_guide.md | 2 +- 3 files changed, 8 insertions(+), 8 deletions(-) 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 85348dfe..f5b2ea36 100644 --- a/doc/developer_guide.md +++ b/doc/developer_guide.md @@ -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 ``` 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 ```