This is an automated email from the ASF dual-hosted git repository. pkarwasz pushed a commit to branch feat/reusable-workflow in repository https://gitbox.apache.org/repos/asf/commons-parent.git
commit 8638d2bb86a79b5afaa797fd6313daefd41776c3 Author: Piotr P. Karwasz <[email protected]> AuthorDate: Wed Nov 5 11:13:14 2025 +0100 feat: Add reusable `maven-reusable.yml` workflow Adds a reusable GitHub Actions workflow providing a standard Maven-based CI for Commons projects. Centralizing the CI definition reduces maintenance across repositories and simplifies updates such as adding new JDK versions or upgrading actions. --- .github/workflows/README.md | 54 ++++++++++++++++++++++++++ .github/workflows/maven-reusable.yml | 75 ++++++++++++++++++++++++++++++++++++ .github/workflows/maven.yml | 35 ++--------------- 3 files changed, 133 insertions(+), 31 deletions(-) diff --git a/.github/workflows/README.md b/.github/workflows/README.md new file mode 100644 index 0000000..a914878 --- /dev/null +++ b/.github/workflows/README.md @@ -0,0 +1,54 @@ +<!--- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + https://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +# Reusable Workflows + +This directory contains +[reusable GitHub Actions workflows](https://docs.github.com/en/actions/how-tos/reuse-automations/reuse-workflows) +shared across Apache Commons projects. +They provide a consistent and secure CI setup without duplicating configuration in each repository. + +## Java CI (`maven-reusable.yml`) + +This reusable workflow performs the standard Java build and test process for Commons components. + +### Features + +- Builds the project using a matrix of operating systems and JDK versions. +- Caches dependencies for faster builds. +- Uploads test reports for later inspection. +- Supports experimental JDKs via the matrix configuration. + +### Usage Example + +To include this workflow in a Commons repository, add the following file to `.github/workflows/maven.yml`: + +```yaml +name: Java CI + +on: + push: + branches: [ "master", "release" ] + pull_request: { } + +# Explicitly drop all permissions for security. +permissions: { } + +jobs: + build: + # Intentionally not pinned: maintained by the same PMC. + uses: apache/commons-parent/.github/workflows/maven-reusable.yml@master +``` \ No newline at end of file diff --git a/.github/workflows/maven-reusable.yml b/.github/workflows/maven-reusable.yml new file mode 100644 index 0000000..5b82e3c --- /dev/null +++ b/.github/workflows/maven-reusable.yml @@ -0,0 +1,75 @@ +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +name: Java CI (reusable) + +on: + workflow_call: { } + +# Explicitly drop all permissions inherited from the caller for security. +permissions: { } + +jobs: + build: + # + # Name of the job to be used in .asf.yaml required CI checks. + # + name: build (${{ matrix.os }}, JDK ${{ matrix.java }}) + runs-on: ${{ matrix.os }} + continue-on-error: ${{ matrix.experimental }} + strategy: + matrix: + os: [ ubuntu-latest, windows-latest, macos-latest ] + java: [ 8, 11, 17, 21, 25 ] + experimental: [ false ] + # Keep the same parameter order as the matrix above + # + # PMD does not yet support Java 26 (see https://github.com/pmd/pmd/issues/5871). + # It is therefore too soon to run tests with Java 26. + # Uncomment the following lines once the above issue has been resolved. + # + # include: + # - os: ubuntu-latest + # java: 26-ea + # experimental: true + + steps: + - name: Checkout repository + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 + with: + persist-credentials: false + + - name: Set up JDK ${{ matrix.java }} + uses: actions/setup-java@dded0888837ed1f317902acf8a20df0ad188d165 # v5.0.0 + with: + distribution: ${{ runner.os == 'macOS' && matrix.java == 8 && 'zulu' || 'temurin' }} + java-version: ${{ matrix.java }} + + - name: Build with Maven + run: mvn --errors --show-version --batch-mode --no-transfer-progress -Ddoclint=all + + # Always collect surefire/failsafe reports if they exist (esp. on failure) + - name: Upload test reports + if: always() + uses: actions/upload-artifact@330a01c490aca151604b8cf639adc76d48f6c5d4 # v5.0.0 + with: + name: surefire-reports-${{ matrix.os }}-jdk${{ matrix.java }} + if-no-files-found: ignore + retention-days: 7 + path: | + **/target/surefire-reports/*.xml + **/target/surefire-reports/*.txt + **/target/failsafe-reports/*.xml + **/target/failsafe-reports/*.txt \ No newline at end of file diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 5967c15..ed74735 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -15,38 +15,11 @@ name: Java CI -on: [push, pull_request] +on: [ push, pull_request ] -permissions: - contents: read +# Explicitly drop all permissions inherited from the caller for security. +permissions: { } jobs: build: - - runs-on: ubuntu-latest - # we want to try all Java versions here. - continue-on-error: true - strategy: - matrix: - java: [ 8, 11, 17, 21, 24 ] - include: - - java: 25-ea - experimental: true - - steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # 4.2.2 - with: - persist-credentials: false - - uses: actions/cache@5a3ec84eff668545956fd18022155c47e93e2684 # v4.2.3 - with: - path: ~/.m2/repository - key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }} - restore-keys: | - ${{ runner.os }}-maven- - - name: Set up JDK ${{ matrix.java }} - uses: actions/setup-java@c5195efecf7bdfc987ee8bae7a71cb8b11521c00 # v4.7.1 - with: - distribution: 'temurin' - java-version: ${{ matrix.java }} - - name: Build with Maven - run: mvn --errors --show-version --batch-mode --no-transfer-progress + uses: ./github/workflows/maven-reusable.yml
