From 0ade3216e457cde27c59ae4b98275afa28cdc5bc Mon Sep 17 00:00:00 2001 From: Gerard Olenski Date: Fri, 14 Mar 2025 08:38:32 +0100 Subject: [PATCH] ACS-9417 Reformat code and simplify CI --- .github/workflows/ci.yml | 186 +++++++++--------- .github/workflows/master_release.yml | 16 +- .github/workflows/precommit_formatter.yml | 32 +++ .secrets.baseline | 8 +- CONTRIBUTING.md | 4 +- .../java/org/alfresco/util/SortDirection.java | 28 ++- pom.xml | 7 +- scripts/hooks/check-format-and-headers.sh | 35 +--- 8 files changed, 167 insertions(+), 149 deletions(-) create mode 100644 .github/workflows/precommit_formatter.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3926433b33..5b159fbe20 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -44,14 +44,10 @@ jobs: - uses: actions/checkout@v4 with: fetch-depth: 0 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 - - id: changed-files - uses: Alfresco/alfresco-build-tools/.github/actions/github-list-changes@v8.13.0 - with: - write-list-to-env: true - - uses: Alfresco/alfresco-build-tools/.github/actions/pre-commit@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/pre-commit@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Prepare maven cache and check compilation" @@ -69,12 +65,12 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - - uses: Alfresco/alfresco-build-tools/.github/actions/veracode@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/veracode@v8.16.0 continue-on-error: true with: srcclr-api-token: ${{ secrets.SRCCLR_API_TOKEN }} @@ -92,10 +88,10 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/github-download-file@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/github-download-file@v8.16.0 with: token: ${{ secrets.BOT_GITHUB_TOKEN }} repository: "Alfresco/veracode-baseline-archive" @@ -148,9 +144,9 @@ jobs: !contains(github.event.head_commit.message, '[skip tests]') && !contains(github.event.head_commit.message, '[force]') steps: - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - uses: Alfresco/ya-pmd-scan@v4.1.0 with: classpath-build-command: "mvn test-compile -ntp -Pags -pl \"-:alfresco-community-repo-docker\"" @@ -181,14 +177,14 @@ jobs: testAttributes: "-Dtest=AllMmtUnitTestSuite" steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} - ${{ matrix.testModule }} @@ -219,7 +215,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -261,9 +257,9 @@ jobs: REQUIRES_INSTALLED_ARTIFACTS: true steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Build" timeout-minutes: ${{ fromJSON(env.GITHUB_ACTIONS_DEPLOY_TIMEOUT) }} run: | @@ -276,7 +272,7 @@ jobs: run: docker compose -f ./scripts/ci/docker-compose/docker-compose.yaml --profile ${{ matrix.compose-profile }} up -d - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} - ${{ matrix.testSuite }} @@ -307,7 +303,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -340,9 +336,9 @@ jobs: version: ['10.5', '10.6'] steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: Run MariaDB ${{ matrix.version }} database @@ -351,7 +347,7 @@ jobs: MARIADB_VERSION: ${{ matrix.version }} - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} - ${{ matrix.version }} @@ -382,7 +378,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -411,9 +407,9 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Run MariaDB 10.11 database" @@ -422,7 +418,7 @@ jobs: MARIADB_VERSION: 10.11 - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -453,7 +449,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -482,9 +478,9 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Run MySQL 8 database" @@ -493,7 +489,7 @@ jobs: MYSQL_VERSION: 8 - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -524,7 +520,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -552,9 +548,9 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Run PostgreSQL 14.15 database" @@ -563,7 +559,7 @@ jobs: POSTGRES_VERSION: 14.15 - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -594,7 +590,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -622,9 +618,9 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Run PostgreSQL 15.10 database" @@ -633,7 +629,7 @@ jobs: POSTGRES_VERSION: 15.10 - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -664,7 +660,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -692,9 +688,9 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Run PostgreSQL 16.6 database" @@ -703,7 +699,7 @@ jobs: POSTGRES_VERSION: 16.6 - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -734,7 +730,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -760,16 +756,16 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Run ActiveMQ" run: docker compose -f ./scripts/ci/docker-compose/docker-compose.yaml --profile activemq up -d - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -800,7 +796,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -860,9 +856,9 @@ jobs: mvn-options: '-Dencryption.ssl.keystore.location=${CI_WORKSPACE}/keystores/alfresco/alfresco.keystore -Dencryption.ssl.truststore.location=${CI_WORKSPACE}/keystores/alfresco/alfresco.truststore' steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Set transformers tag" @@ -885,7 +881,7 @@ jobs: run: docker compose -f ./scripts/ci/docker-compose/docker-compose.yaml --profile ${{ matrix.compose-profile }} up -d - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} - ${{ matrix.testSuite }} ${{ matrix.idp }} @@ -916,7 +912,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -974,9 +970,9 @@ jobs: REQUIRES_LOCAL_IMAGES: true steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Build" timeout-minutes: ${{ fromJSON(env.GITHUB_ACTIONS_DEPLOY_TIMEOUT) }} run: | @@ -992,7 +988,7 @@ jobs: run: mvn install -pl :alfresco-community-repo-integration-test -am -DskipTests -Pall-tas-tests - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} - ${{ matrix.test-name }} @@ -1030,7 +1026,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.tests.outcome }} @@ -1056,16 +1052,16 @@ jobs: !contains(github.event.head_commit.message, '[force') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - name: "Run Postgres 16.6 database" run: docker compose -f ./scripts/ci/docker-compose/docker-compose.yaml --profile postgres up -d - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -1096,7 +1092,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -1130,9 +1126,9 @@ jobs: REQUIRES_INSTALLED_ARTIFACTS: true steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Build" timeout-minutes: ${{ fromJSON(env.GITHUB_ACTIONS_DEPLOY_TIMEOUT) }} run: | @@ -1140,7 +1136,7 @@ jobs: bash ./scripts/ci/build.sh - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} 0${{ matrix.part }} - (PostgreSQL) ${{ matrix.test-name }} @@ -1176,9 +1172,9 @@ jobs: REQUIRES_INSTALLED_ARTIFACTS: true steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Build" timeout-minutes: ${{ fromJSON(env.GITHUB_ACTIONS_DEPLOY_TIMEOUT) }} run: | @@ -1186,7 +1182,7 @@ jobs: bash ./scripts/ci/build.sh - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} 0${{ matrix.part }} - (MySQL) ${{ matrix.test-name }} @@ -1218,9 +1214,9 @@ jobs: REQUIRES_LOCAL_IMAGES: true steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Build" timeout-minutes: ${{ fromJSON(env.GITHUB_ACTIONS_DEPLOY_TIMEOUT) }} run: | @@ -1234,7 +1230,7 @@ jobs: mvn -B install -pl :alfresco-governance-services-automation-community-rest-api -am -Pags -Pall-tas-tests -DskipTests - name: "Prepare Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-prepare@v8.16.0 id: rp-prepare with: rp-launch-prefix: ${{ env.RP_LAUNCH_PREFIX }} @@ -1266,7 +1262,7 @@ jobs: continue-on-error: true - name: "Summarize Report Portal" if: github.ref_name == 'master' - uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.13.0 + uses: Alfresco/alfresco-build-tools/.github/actions/reportportal-summarize@v8.16.0 id: rp-summarize with: tests-outcome: ${{ steps.run-tests.outcome }} @@ -1308,9 +1304,9 @@ jobs: !contains(github.event.head_commit.message, '[force]') steps: - uses: actions/checkout@v4 - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Build" timeout-minutes: ${{ fromJSON(env.GITHUB_ACTIONS_DEPLOY_TIMEOUT) }} run: | diff --git a/.github/workflows/master_release.yml b/.github/workflows/master_release.yml index 89d60e46eb..6fdd4eaed5 100644 --- a/.github/workflows/master_release.yml +++ b/.github/workflows/master_release.yml @@ -34,12 +34,12 @@ jobs: - uses: actions/checkout@v4 with: persist-credentials: false - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - - uses: Alfresco/alfresco-build-tools/.github/actions/configure-git-author@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/configure-git-author@v8.16.0 with: username: ${{ env.GIT_USERNAME }} email: ${{ env.GIT_EMAIL }} @@ -63,12 +63,12 @@ jobs: - uses: actions/checkout@v4 with: persist-credentials: false - - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.13.0 - - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/get-build-info@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/free-hosted-runner-disk-space@v8.16.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/setup-java-build@v8.16.0 - name: "Init" run: bash ./scripts/ci/init.sh - - uses: Alfresco/alfresco-build-tools/.github/actions/configure-git-author@v8.13.0 + - uses: Alfresco/alfresco-build-tools/.github/actions/configure-git-author@v8.16.0 with: username: ${{ env.GIT_USERNAME }} email: ${{ env.GIT_EMAIL }} diff --git a/.github/workflows/precommit_formatter.yml b/.github/workflows/precommit_formatter.yml new file mode 100644 index 0000000000..380ea2c759 --- /dev/null +++ b/.github/workflows/precommit_formatter.yml @@ -0,0 +1,32 @@ +name: Pre-Commit formatter + +on: + push: + branches: + - precommit/** + +jobs: + format-code: + name: "Reformat code" + runs-on: ubuntu-latest + if: contains(github.event.head_commit.message, '[reformat code]') + steps: + - uses: actions/checkout@v4 + - name: Set up Python ${{ inputs.python-version }} + uses: actions/setup-python@42375524e23c412d93fb67b49958b491fce71c38 # v5.4.0 + with: + python-version: "3.9" + - uses: pre-commit/action@2c7b3805fd2a0fd8c1884dcaebf91fc102a13ecd # v3.0.1 + continue-on-error: true + with: + extra_args: --all-files + - name: Update secrets baseline + run: pip install detect-secrets && detect-secrets scan --baseline .secrets.baseline + - uses: Alfresco/alfresco-build-tools/.github/actions/git-commit-changes@v8.16.0 + with: + username: ${{ secrets.BOT_GITHUB_USERNAME }} + add-options: -u + commit-message: "Apply Pre-Commit code formatting" + skip-if-no-changes: true + - name: Push changes + run: git push diff --git a/.secrets.baseline b/.secrets.baseline index b160381264..ac1af6dd4e 100644 --- a/.secrets.baseline +++ b/.secrets.baseline @@ -133,21 +133,21 @@ "filename": ".github/workflows/ci.yml", "hashed_secret": "b86dc2f033a63f2b7b9e7d270ab806d2910d7572", "is_verified": false, - "line_number": 299 + "line_number": 295 }, { "type": "Secret Keyword", "filename": ".github/workflows/ci.yml", "hashed_secret": "1bfb0e20f886150ba59b853bcd49dea893e00966", "is_verified": false, - "line_number": 374 + "line_number": 370 }, { "type": "Secret Keyword", "filename": ".github/workflows/ci.yml", "hashed_secret": "128f14373ccfaff49e3664045d3a11b50cbb7b39", "is_verified": false, - "line_number": 908 + "line_number": 904 } ], ".github/workflows/master_release.yml": [ @@ -1868,5 +1868,5 @@ } ] }, - "generated_at": "2025-02-26T15:13:52Z" + "generated_at": "2025-03-14T07:37:47Z" } diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f34a26c43..5329490835 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,7 +10,9 @@ pre-commit install When you make a commit then these hooks will run and check the modified files. If it makes changes then you can review them and then `git commit` again to accept the changes. #### Code Quality -This project uses `spotless` that enforces `alfresco-formatter.xml` to ensure code quality. +This project uses `spotless` that enforces `alfresco-formatter.xml` to ensure code quality. +The code style definition file is taken always form the `master` branch of `alfresco-community-repo`. +All downstream projects use this code style definition file as well. To check code-style violations you can use: ```bash diff --git a/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/util/SortDirection.java b/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/util/SortDirection.java index f012a178cf..a66e293c99 100644 --- a/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/util/SortDirection.java +++ b/amps/ags/rm-community/rm-community-repo/source/java/org/alfresco/util/SortDirection.java @@ -1,3 +1,29 @@ +/* + * #%L + * Alfresco Records Management Module + * %% + * Copyright (C) 2005 - 2025 Alfresco Software Limited + * %% + * This file is part of the Alfresco software. + * - + * If the software was purchased under a paid Alfresco license, the terms of + * the paid license agreement will prevail. Otherwise, the software is + * provided under the following open source license terms: + * - + * Alfresco is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * - + * Alfresco is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License for more details. + * - + * You should have received a copy of the GNU Lesser General Public License + * along with Alfresco. If not, see . + * #L% + */ package org.alfresco.util; import org.alfresco.api.AlfrescoPublicApi; @@ -77,4 +103,4 @@ public enum SortDirection return sortDirection; } -} \ No newline at end of file +} diff --git a/pom.xml b/pom.xml index 34371a804e..592c38b3ba 100644 --- a/pom.xml +++ b/pom.xml @@ -120,8 +120,6 @@ 2.2.0 2.4.0 2.44.2 - - NO_AUTOMATED_FORMATTING 42.7.5 8.0.30 @@ -1156,11 +1154,8 @@ ${spotless-plugin.version} - - ${spotless-include-list} - - alfresco-formatter.xml + https://raw.githubusercontent.com/Alfresco/alfresco-community-repo/refs/heads/master/alfresco-formatter.xml \#java|\#javax|\#jakarta,\#,\#org.alfresco,java|javax|jakarta,,org.alfresco diff --git a/scripts/hooks/check-format-and-headers.sh b/scripts/hooks/check-format-and-headers.sh index 26286305d8..339690004b 100755 --- a/scripts/hooks/check-format-and-headers.sh +++ b/scripts/hooks/check-format-and-headers.sh @@ -2,39 +2,6 @@ set +x -if [[ -z ${GITHUB_MODIFIED_FILES} ]] -then - modified_files=$(git diff --cached --name-only --diff-filter=ACMR) -else - modified_files=${GITHUB_MODIFIED_FILES} -fi - -include_list="" -for file in ${modified_files} -do - include_list="${include_list},${file}" -done -include_list=${include_list:1} - -mvn spotless:apply validate -DlicenseUpdateHeaders=true -Pags,all-tas-tests -Dspotless-include-list="${include_list}" > /dev/null || true - -all_nonconformant_files=$(git diff --name-only --diff-filter=ACMR) - -for file in ${all_nonconformant_files} -do - revert=1 - for modified_file in ${modified_files} - do - if [[ "${modified_file}" == "${file}" ]] - then - revert=0 - break - fi - done - if [[ ${revert} == 1 ]] - then - git checkout -- "${file}" - fi -done +mvn spotless:apply validate -DlicenseUpdateHeaders=true -Pags,all-tas-tests > /dev/null || true set -x