support adding settings-path for settings.xml (#95)

Co-authored-by: Slawomir Jaranowski <s.jaranowski@gmail.com>

.github/workflows/release-drafter.yml

@@ -9,14 +9,4 @@ on:
 jobs:
   update_release_draft:
     name: Update Release Draft
-    runs-on: ubuntu-latest
-    concurrency: release-drafter
-
-    if: >
-      github.repository_owner == 's4u'
-      && !startsWith(github.event.head_commit.message , '[maven-release-plugin]')
-
-    steps:
-      - uses: release-drafter/release-drafter@v5.21.1
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+    uses: s4u/.github/.github/workflows/release-drafter.yml@master

.github/workflows/test.yml

@@ -18,14 +18,14 @@ jobs:
     strategy:
       matrix:
         os: [ 'ubuntu-latest', 'windows-latest', 'macOS-latest' ]
-        java: [ '8', '11', '17' ]
-        maven: [ '3.5.4', '3.6.3', '3.8.6' ]
+        java: [ '8', '11', '17', '21' ]
+        maven: [ '3.8.8', '3.9.9' ]
       fail-fast: false
 
     runs-on: ${{ matrix.os }}
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - uses: ./
         with:
@@ -36,31 +36,27 @@ jobs:
       - run: mvn -V validate -Drequire.java=${{ matrix.java }} -Drequire.maven=${{ matrix.maven }}
         shell: bash
 
-  test-deault:
+  test-default:
     name: Test with defaults
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
       - uses: ./
-        with:
-          java-version: 8
 
-      - run: mvn -V validate -Drequire.java=8 -Drequire.maven=3.8.6
+      - run: mvn -V validate -Drequire.java=17 -Drequire.maven=3.9.9
         shell: bash
 
   test-ok:
     name: Test OK
     runs-on: ubuntu-latest
-    needs: [ test, test-deault ]
+    needs: [ test, test-default ]
     if: always()
 
     steps:
-      - run: echo "needs.test.result=${{ needs.test.result }} needs.test-deault.result=${{ needs.test-deault.result }}"
-
       - run: 'true'
-        if: needs.test.result == 'success' && needs.test-deault.result == 'success'
+        if: join(needs.*.result, ',') == 'success,success'
 
       - run: 'false'
-        if: needs.test.result != 'success' || needs.test-deault.result != 'success'
+        if: join(needs.*.result, ',') != 'success,success'

README.md

@@ -9,38 +9,41 @@ This is composite action which help to prepare GitHub Actions environment for Ma
 - [stCarolas/setup-maven](https://github.com/marketplace/actions/setup-maven)
 - [s4u/maven-settings-action](https://github.com/marketplace/actions/maven-settings-action)
 
-# Contributions
+:exclamation: You **should not** include above actions in your configuration - in other case  those will be **called twice**. :exclamation:
 
-- Contributions are welcome!
-- Give :star: - if you want to encourage me to work on a project
-- Don't hesitate to create issues for new features you dream of or if you suspect some bug
+For default values you only need:
 
-# Project versioning
+```yml
+    steps:
 
-This project uses [Semantic Versioning](https://semver.org/).
-We recommended using the latest and specific release version.
+      - name: Setup Maven Action
+        uses: s4u/setup-maven-action@< version >
 
-In order to keep your project dependencies up to date you can watch this repository *(Releases only)*
-or use automatic tools like [Dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates).
+      - run: mvn -V ...
+```
 
 # Params mapping for sub actions
 
-**Notice** when used this action you should not used mentioned below actions again.
-
 ## checkout
 
-| params                       | destination         | default |
-|------------------------------|---------------------|---------|
-| checkout-fetch-depth         | fetch-depth         |         |
-| checkout-path                | path                |         |
-| checkout-persist-credentials | persist-credentials | false   |
+| params                       | destination         | default                  |
+|------------------------------|---------------------|--------------------------|
+| checkout-enabled             | enabled             |  true                    |
+| checkout-fetch-depth         | fetch-depth         |                          |
+| checkout-submodules          | submodules          |                          |
+| checkout-path                | path                |                          |
+| checkout-ref                 | ref                 |                          |
+| checkout-repository          | repository          | ${{ github.repository }} |
+| checkout-token               | token               | ${{ github.token }}      |
+| checkout-ssh-key             | ssh-key             |                          |
+| checkout-persist-credentials | persist-credentials | false                    |
 
 ## setup-java
 
 | params            | destination  | default |
 |-------------------|--------------|---------|
-| java-version      | java-version |         |
-| java-distribution | distribution | temurin |
+| java-version      | java-version | 17      |
+| java-distribution | distribution | zulu    |
 
 ## cache
 
@@ -60,7 +63,8 @@ So we can use for action:
 
 | params         | description                                              |
 |----------------|----------------------------------------------------------|
-| cache-path     | default cache path for Maven with value ~/.m2/repository | 
+| cache-enabled  | enable cache. Default true                               |
+| cache-path     | default cache path for Maven with value ~/.m2/repository |
 | cache-path-add | additional value for cache path                          |
 | cache-prefix   | prefix value for `key` and `restore-keys` cache params   |
 
@@ -69,7 +73,7 @@ So we can use for action:
 
 | params        | destination   | default |
 |---------------|---------------|---------|
-| maven-version | maven-version | 3.8.6   |
+| maven-version | maven-version | 3.9.9   |
 
 ## maven-settings-action
 
@@ -79,6 +83,10 @@ So we can use for action:
 | settings-mirrors           | mirrors           |
 | settings-properties        | properties        |
 | settings-sonatypeSnapshots | sonatypeSnapshots |
+| settings-proxies           | proxies           |
+| settings-repositories      | repositories      |
+| settings-githubServer      | githubServer      |
+| settings-path              | path              |
 
 # Testing against different Maven versions
 
@@ -90,7 +98,7 @@ jobs:
 
     strategy:
       matrix:
-        maven: [ '3.5.4', '3.6.3', '3.8.6' ]
+        maven: [ '3.8.8', '3.9.8' ]
 
     name: Maven ${{ matrix.maven }} sample
 
@@ -105,6 +113,20 @@ jobs:
       - run: mvn -V ...
 ```
 
+# Contributions
+
+- Contributions are welcome!
+- Give :star: - if you want to encourage me to work on a project
+- Don't hesitate to create issues for new features you dream of or if you suspect some bug
+
+# Project versioning
+
+This project uses [Semantic Versioning](https://semver.org/).
+We recommended using the latest and specific release version.
+
+In order to keep your project dependencies up to date you can watch this repository *(Releases only)*
+or use automatic tools like [Dependabot](https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/about-dependabot-version-updates).
+
 # License
 
 The scripts and documentation in this project are released under the [MIT License](LICENSE)

action.yml

@@ -8,10 +8,19 @@ branding:
 inputs:
 
   # checkout
+  checkout-enabled:
+    description: 'Enable checkout'
+    default: 'true'
+    required: false
+
   checkout-fetch-depth:
     description: 'Number of commits to fetch'
     required: false
 
+  checkout-submodules:
+    description: 'Whether to fetch submodules'
+    required: false
+
   checkout-path:
     description: 'Relative path under $GITHUB_WORKSPACE to place the repository'
     required: false
@@ -21,19 +30,42 @@ inputs:
     default: 'false'
     required: false
 
+  checkout-ref:
+    description: 'The branch, tag, or SHA of the repository to clone'
+    required: false
+
+  checkout-repository:
+    description: 'The repository to checkout if not the repository that triggered the action. For use when building GitHub Apps'
+    required: false
+    default: ${{ github.repository }}
+
+  checkout-token:
+    description: 'Token to use for checkout if checking out a repository out of scope for GITHUB_TOKEN'
+    required: false
+    default: ${{ github.token }}
+
+  checkout-ssh-key:
+    description: 'SSH key used to fetch the repository. It allows to run authenticated git commands'
+    required: false
 
   # java jdk params
 
   java-version:
     description: 'The Java version to set up'
+    default: '17'
     required: true
 
   java-distribution:
     description: 'Java distribution'
-    default: 'temurin'
+    default: 'zulu'
     required: false
 
   # cache
+  cache-enabled:
+    description: 'Enable cache'
+    default: 'true'
+    required: false
+
   cache-prefix:
     description: 'Cache key prefix'
     required: false
@@ -50,44 +82,68 @@ inputs:
   # maven version
   maven-version:
     description: 'The Maven version to set up'
-    default: '3.8.6'
+    default: '3.9.9'
     required: false
 
   # maven settings.xml
   settings-servers:
-    description: 'servers definition in json array, eg: [{"id": "serverId", "username": "username", "password": "password"}]'
+    description: 'servers definition in json array, e.g.: [{"id": "serverId", "username": "username", "password": "password"}]'
     required: false
 
   settings-mirrors:
-    description: 'mirrors definition in json array, eg: [{"id": "id", "name": "name", "mirrorOf": "mirrorOf", "url": "url"}]'
+    description: 'mirrors definition in json array, e.g.: [{"id": "id", "name": "name", "mirrorOf": "mirrorOf", "url": "url"}]'
     required: false
 
   settings-properties:
-    description: 'json array with properties, eg [{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]'
+    description: 'json array with properties, e.g.: [{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]'
     required: false
 
   settings-sonatypeSnapshots:
     description: 'add https://oss.sonatype.org/content/repositories/snapshots to repository list - true or false'
     required: false
 
+  settings-proxies:
+    description: 'proxies definition in json array, e.g.: [{"id": "http-proxy", "active": "true", "protocol": "http", "host": "host", "port": "port", "nonProxyHosts": "host1|host2"}]'
+    required: false
+
+  settings-repositories:
+    description: 'repository settings definition in json array, e.g.: [ { "id": "repoId","name": "repoName","url": "url","snapshots": { "enabled": true } } ]'
+    required: false
+
+  settings-githubServer:
+    description: 'add to settings.xml servers server-id: github; username=$GITHUB_ACTOR and password=$GITHUB_TOKEN'
+    default: "true"
+    required: false
+
+  settings-path:
+    description: 'override default path to settings.xml which is $HOME/.m2/settings.xml'
+    required: false
+
 runs:
   using: 'composite'
 
   steps:
 
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
+      if: inputs.checkout-enabled == 'true'
       with:
         fetch-depth: '${{ inputs.checkout-fetch-depth }}'
+        submodules: '${{ inputs.checkout-submodules }}'
         path: '${{ inputs.checkout-path }}'
         persist-credentials: '${{ inputs.checkout-persist-credentials }}'
+        ref: '${{ inputs.checkout-ref }}'
+        repository: '${{ inputs.checkout-repository }}'
+        token: '${{ inputs.checkout-token }}'
+        ssh-key: '${{ inputs.checkout-ssh-key }}'
 
-    - uses: actions/setup-java@v3
+    - uses: actions/setup-java@8df1039502a15bceb9433410b1a100fbe190c53b
       with:
         overwrite-settings: false
         java-version: '${{ inputs.java-version }}'
         distribution: '${{ inputs.java-distribution }}'
 
-    - uses: actions/cache@v3
+    - uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4.1.2
+      if: inputs.cache-enabled == 'true'
       with:
         path: |
           ${{ inputs.cache-path }}
@@ -100,14 +156,18 @@ runs:
       shell: bash
       id: current-maven
 
-    - uses: stCarolas/setup-maven@v4.5
+    - uses: stCarolas/setup-maven@d6af6abeda15e98926a57b5aa970a96bb37f97d1 # v5
       if: inputs.maven-version != steps.current-maven.outputs.version
       with:
         maven-version: '${{ inputs.maven-version }}'
 
-    - uses: s4u/maven-settings-action@v2.8.0
+    - uses: s4u/maven-settings-action@64e42c454dbd42ef6370ac8539685755aedd205b # v3.1.0
       with:
-        servers: '${{ inputs.settings-servers}}'
-        mirrors: '${{ inputs.settings-mirrors}}'
-        properties: '${{ inputs.settings-properties}}'
-        sonatypeSnapshots: '${{ inputs.settings-sonatypeSnapshots}}'
+        servers: '${{ inputs.settings-servers }}'
+        mirrors: '${{ inputs.settings-mirrors }}'
+        properties: '${{ inputs.settings-properties }}'
+        sonatypeSnapshots: '${{ inputs.settings-sonatypeSnapshots }}'
+        proxies: '${{ inputs.settings-proxies }}'
+        repositories: '${{ inputs.settings-repositories }}'
+        githubServer: '${{ inputs.settings-githubServer }}'
+        path: '${{ inputs.settings-path }}'

pom.xml

@@ -36,7 +36,6 @@
     <properties>
         <require.maven/>
         <require.java/>
-        <_require.java/>
     </properties>
 
     <build>
@@ -44,11 +43,10 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-enforcer-plugin</artifactId>
-                <version>3.0.0-M3</version>
+                <version>3.2.1</version>
                 <executions>
                     <execution>
                         <goals>
-                            <goal>display-info</goal>
                             <goal>enforce</goal>
                         </goals>
                         <phase>validate</phase>
@@ -57,7 +55,7 @@
                 <configuration>
                     <rules>
                         <requireJavaVersion>
-                            <version>${_require.java}</version>
+                            <version>${require.java}</version>
                         </requireJavaVersion>
                         <requireMavenVersion>
                             <version>[${require.maven}]</version>
@@ -67,32 +65,4 @@
             </plugin>
         </plugins>
     </build>
-
-    <profiles>
-        <profile>
-            <id>java8-version-label</id>
-            <activation>
-                <property>
-                    <name>require.java</name>
-                    <value>8</value>
-                </property>
-            </activation>
-            <properties>
-                <_require.java>1.8</_require.java>
-            </properties>
-        </profile>
-
-        <profile>
-            <id>non-java8-version-label</id>
-            <activation>
-                <property>
-                    <name>require.java</name>
-                    <value>!8</value>
-                </property>
-            </activation>
-            <properties>
-                <_require.java>${require.java}</_require.java>
-            </properties>
-        </profile>
-    </profiles>
 </project>