[maven-gh-actions-shared] branch main updated: Introduce V3 version in documentation

[sj...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

sjaranowski pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/maven-gh-actions-shared.git


The following commit(s) were added to refs/heads/main by this push:
     new 51ec3c3  Introduce V3 version in documentation
51ec3c3 is described below

commit 51ec3c3f7cb06476fee36b9ec4557913a1bedb79
Author: Slawomir Jaranowski <s....@gmail.com>
AuthorDate: Wed Jul 6 08:17:40 2022 +0200

    Introduce V3 version in documentation
---
 .github/dependabot.yml |  6 ++++++
 README.md              | 26 +++++++++++++++++++++-----
 2 files changed, 27 insertions(+), 5 deletions(-)

diff --git a/.github/dependabot.yml b/.github/dependabot.yml
index b7efc57..c4a7d68 100644
--- a/.github/dependabot.yml
+++ b/.github/dependabot.yml
@@ -29,3 +29,9 @@ updates:
     target-branch: "v2"
     schedule:
       interval: "daily"
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    target-branch: "v3"
+    schedule:
+      interval: "daily"
diff --git a/README.md b/README.md
index 34e3863..d86a692 100644
--- a/README.md
+++ b/README.md
@@ -54,7 +54,7 @@ on:
 jobs:
   build:
     name: Verify
-    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
+    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
 
 ```
 ## Events that can trigger workflows
@@ -71,6 +71,12 @@ if `PR` is created for local branch.
 
 Only workflow for PR from external forks will be executed.
 
+## Breaking changes in V3 
+
+ - replace `maven_version` by `maven-matrix` and `ff-maven`
+ - rename `maven_args` to `maven-args`
+ - remove not used `verify-site-goal`
+
 # Additional configurations
 
 ## Attach logs on failure
@@ -79,7 +85,7 @@ We can store some logs of execution in case of failure as workflow attachments:
 
 ```yaml
 ...
-    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
+    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
     with:
       failure-upload-path: |
         **/target/surefire-reports/*
@@ -88,7 +94,7 @@ We can store some logs of execution in case of failure as workflow attachments:
 
 ```yaml
 ...
-    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
+    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
     with:
       matrix-exclude: >
         [ 
@@ -102,17 +108,27 @@ We can store some logs of execution in case of failure as workflow attachments:
 
 ```yaml
 ...
-    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v2
+    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
     with:
       ff-goal: 'install'
       verify-goal: 'install -P run-its'
 ```
 
+## Testing against different Maven versions
+
+```yaml
+...
+    uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v3
+    with:
+      ff-maven: "3.8.6"                     # Maven version for fail-fast-build
+      maven-matrix: '[ "3.2.5", "3.8.6" ]'  # Maven versions matrix for verify builds
+```
+
 ## 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
+https://github.com/apache/maven-gh-actions-shared/blob/v3/.github/workflows/maven-verify.yml
 
 # Resources