Google Git
Sign in
apache / maven-gh-actions-shared / 41f019c9dd84f0273e424244d26c033ac6be0af1
commit41f019c9dd84f0273e424244d26c033ac6be0af1[log] [tgz]
authorSlawomir Jaranowski <s.jaranowski@gmail.com>Thu Feb 17 00:03:27 2022 +0100
committerGitHub <noreply@github.com>Thu Feb 17 00:03:27 2022 +0100
treec23193d9958898ff0ede5744756cae34317b7b14
parent08aa846c2c13fdfed9136186962003dbb9d16d2b [diff]
dependabot for branch v2
1 file changed
tree: c23193d9958898ff0ede5744756cae34317b7b14
  1. .github/
  2. .asf.yaml
  3. .gitignore
  4. LICENSE
  5. README.md
README.md

Apache Maven Shared GitHub Actions

Usage

Create GitHub workflow in project file:

.github/workflows/maven-verify.yml

with content:

# 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
#
#       http://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: Verify

on:
  push:
  pull_request:

jobs:
  build:
    name: Verify
    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2

Events that can trigger workflows

In such configuration workflow can be executed in the same time twice for two separate events.

It can occurs when we create PR for branch from the same repository, we have two events:

  • push on branch
  • pull_request on PR for the same branch

In order to minimize resource consumptions shared workflow from version v2 detect such situation and skips the execution for pull_request event if PR is created for local branch.

Only workflow for PR from external forks will be executed.

Additional configurations

Attach logs on failure

We can store some logs of execution in case of failure as workflow attachments:

...
    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
    with:
      failure-upload-path: |
        **/target/surefire-reports/*

Excludes from build matrix:

...
    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
    with:
      matrix-exclude: >
        [ 
          {"jdk": "8"},   # exclude jdk 8 from all builds
          {"os": "windows-latest"}, # exclude windows from all builds
          {"jdk": "8", "os": "windows-latest"} # exclude jkd 8 on windows
        ]

Change default goals

...
    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
    with:
      ff-goal: 'install'
      verify-goal: 'install -P run-its'

More options

More options with default values can be found in workflow source in inputs section:

https://github.com/apache/maven-gh-actions-shared/blob/v2/.github/workflows/maven-verify.yml

Resources