Compare commits

..

No commits in common. "main" and "v1.2.1" have entirely different histories.
main ... v1.2.1

6 changed files with 140 additions and 192 deletions

View File

@ -5,6 +5,30 @@ on:
jobs: jobs:
auto-approve: auto-approve:
uses: s4u/.github/.github/workflows/auto-approve.yml@master runs-on: ubuntu-latest
secrets: steps:
TECH_TOKEN: ${{ secrets.TECH_TOKEN }}
- name: Dependabot metadata
if: github.actor == 'dependabot[bot]'
id: dependabot-metadata
uses: dependabot/fetch-metadata@v1.1.1
with:
github-token: "${{ secrets.TECH_TOKEN }}"
- name: Enable auto-merge for Dependabot PRs
if: >
github.actor == 'dependabot[bot]'
&& steps.dependabot-metadata.outputs.update-type != 'version-update:semver-major'
run: gh pr merge --auto --rebase "$PR_URL"
env:
PR_URL: ${{github.event.pull_request.html_url}}
GITHUB_TOKEN: ${{ secrets.TECH_TOKEN }}
- name: Approve a PR
if: >
github.actor == 'dependabot[bot]'
|| github.actor == 'slawekjaranowski'
run: gh pr review --approve "$PR_URL"
env:
PR_URL: ${{github.event.pull_request.html_url}}
GITHUB_TOKEN: ${{ secrets.TECH_TOKEN }}

View File

@ -5,9 +5,18 @@ on:
branches: branches:
- 'master' - 'master'
- 'main' - 'main'
workflow_dispatch:
jobs: jobs:
update_release_draft: update_release_draft:
name: Update Release Draft name: Update Release Draft
uses: s4u/.github/.github/workflows/release-drafter.yml@master 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.15.0
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@ -11,6 +11,10 @@ on:
schedule: schedule:
- cron: '22 23 * * 5' - cron: '22 23 * * 5'
concurrency:
group: test-action
cancel-in-progress: true
jobs: jobs:
test: test:
name: Test name: Test
@ -18,14 +22,14 @@ jobs:
strategy: strategy:
matrix: matrix:
os: [ 'ubuntu-latest', 'windows-latest', 'macOS-latest' ] os: [ 'ubuntu-latest', 'windows-latest', 'macOS-latest' ]
java: [ '8', '11', '17', '21', '25' ] java: [ '8', '11', '16' ]
maven: [ '3.8.8', '3.9.14' ] maven: [ '3.5.4', '3.6.3', '3.8.2' ]
fail-fast: false fail-fast: false
runs-on: ${{ matrix.os }} runs-on: ${{ matrix.os }}
steps: steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - uses: actions/checkout@v2.3.4
- uses: ./ - uses: ./
with: with:
@ -36,27 +40,3 @@ jobs:
- run: mvn -V validate -Drequire.java=${{ matrix.java }} -Drequire.maven=${{ matrix.maven }} - run: mvn -V validate -Drequire.java=${{ matrix.java }} -Drequire.maven=${{ matrix.maven }}
shell: bash shell: bash
test-default:
name: Test with defaults
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
- uses: ./
- run: mvn -V validate -Drequire.java=17 -Drequire.maven=3.9.14
shell: bash
test-ok:
name: Test OK
runs-on: ubuntu-latest
needs: [ test, test-default ]
if: always()
steps:
- run: 'true'
if: join(needs.*.result, ',') == 'success,success'
- run: 'false'
if: join(needs.*.result, ',') != 'success,success'

View File

@ -9,42 +9,35 @@ This is composite action which help to prepare GitHub Actions environment for Ma
- [stCarolas/setup-maven](https://github.com/marketplace/actions/setup-maven) - [stCarolas/setup-maven](https://github.com/marketplace/actions/setup-maven)
- [s4u/maven-settings-action](https://github.com/marketplace/actions/maven-settings-action) - [s4u/maven-settings-action](https://github.com/marketplace/actions/maven-settings-action)
:exclamation: You **should not** include above actions in your configuration - in other case those will be **called twice**. :exclamation: # Contributions
For default values you only need: - 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
```yml # Project versioning
steps:
- name: Setup Maven Action This project uses [Semantic Versioning](https://semver.org/).
uses: s4u/setup-maven-action@< version > We recommended to use the latest and specific release version.
- run: mvn -V ... 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).
# Params mapping for sub actions # Params mapping for sub actions
## checkout ## checkout
| params | destination | default | | params | destination |
|------------------------------|---------------------|--------------------------| | -------------------------- |------------------ |
| checkout-enabled | enabled | true | | checkout-fetch-depth | fetch-depth |
| 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 ## setup-java
| params | destination | default | | params | destination | default |
|-------------------|--------------|---------| | ----------------- |------------- |-------- |
| java-version | java-version | 17 | | java-version | java-version | |
| java-distribution | distribution | zulu | | java-distribution | distribution | temurin |
| java-jdkFile | jdkFile | |
## cache ## cache
@ -63,8 +56,7 @@ A cache action is configured as:
So we can use for action: So we can use for action:
| params | description | | params | description |
|----------------|----------------------------------------------------------| | ----------------- |--------------------------------------------------------- |
| cache-enabled | enable cache. Default true |
| cache-path | default cache path for Maven with value ~/.m2/repository | | cache-path | default cache path for Maven with value ~/.m2/repository |
| cache-path-add | additional value for cache path | | cache-path-add | additional value for cache path |
| cache-prefix | prefix value for `key` and `restore-keys` cache params | | cache-prefix | prefix value for `key` and `restore-keys` cache params |
@ -73,22 +65,17 @@ So we can use for action:
## setup-maven ## setup-maven
| params | destination | default | | params | destination | default |
|---------------|---------------|---------| | ------------- |-------------- |-------- |
| maven-version | maven-version | 3.9.14 | | maven-version | maven-version | 3.8.1 |
## maven-settings-action ## maven-settings-action
| params | destination | | params | destination |
|-----------------------------|--------------------| | -------------------------- |------------------ |
| settings-servers | servers | | settings-servers | servers |
| settings-mirrors | mirrors | | settings-mirrors | mirrors |
| settings-properties | properties | | settings-properties | properties |
| settings-sonatypeSnapshots | sonatypeSnapshots | | settings-sonatypeSnapshots | sonatypeSnapshots |
| settings-proxies | proxies |
| settings-repositories | repositories |
| settings-pluginRepositories | pluginRepositories |
| settings-githubServer | githubServer |
| settings-path | path |
# Testing against different Maven versions # Testing against different Maven versions
@ -100,7 +87,7 @@ jobs:
strategy: strategy:
matrix: matrix:
maven: [ '3.8.8', '3.9.8' ] maven: [ '3.5.4', '3.6.3', '3.8.2' ]
name: Maven ${{ matrix.maven }} sample name: Maven ${{ matrix.maven }} sample
@ -115,20 +102,6 @@ jobs:
- run: mvn -V ... - 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 # License
The scripts and documentation in this project are released under the [MIT License](LICENSE) The scripts and documentation in this project are released under the [MIT License](LICENSE)

View File

@ -8,68 +8,22 @@ branding:
inputs: inputs:
# checkout # checkout
checkout-enabled:
description: 'Enable checkout'
default: 'true'
required: false
checkout-fetch-depth: checkout-fetch-depth:
description: 'Number of commits to fetch' description: 'Number of commits to fetch'
required: false 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
checkout-persist-credentials:
description: 'Whether to configure the token or SSH key with the local git config'
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 jdk params
java-version: java-version:
description: 'The Java version to set up' description: 'The Java version to set up'
default: '17'
required: true required: true
java-distribution: java-distribution:
description: 'Java distribution' description: 'Java distribution'
default: 'zulu' default: 'temurin'
required: false
java-jdkFile:
description: 'Java JDK compressed file location'
required: false required: false
# cache # cache
cache-enabled:
description: 'Enable cache'
default: 'true'
required: false
cache-prefix: cache-prefix:
description: 'Cache key prefix' description: 'Cache key prefix'
required: false required: false
@ -86,98 +40,76 @@ inputs:
# maven version # maven version
maven-version: maven-version:
description: 'The Maven version to set up' description: 'The Maven version to set up'
default: '3.9.14' default: '3.8.1'
required: false required: false
# maven settings.xml # maven settings.xml
settings-servers: settings-servers:
description: 'servers definition in json array, e.g.: [{"id": "serverId", "username": "username", "password": "password"}]' description: 'servers definition in json array, eg: [{"id": "serverId", "username": "username", "password": "password"}]'
required: false required: false
settings-mirrors: settings-mirrors:
description: 'mirrors definition in json array, e.g.: [{"id": "id", "name": "name", "mirrorOf": "mirrorOf", "url": "url"}]' description: 'mirrors definition in json array, eg: [{"id": "id", "name": "name", "mirrorOf": "mirrorOf", "url": "url"}]'
required: false required: false
settings-properties: settings-properties:
description: 'json array with properties, e.g.: [{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]' description: 'json array with properties, eg [{"propertyName1": "propertyValue1"}, {"propertyName2": "propertyValue2"}]'
required: false required: false
settings-sonatypeSnapshots: settings-sonatypeSnapshots:
description: 'add https://oss.sonatype.org/content/repositories/snapshots to repository list - true or false' description: 'add https://oss.sonatype.org/content/repositories/snapshots to repository list - true or false'
required: 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-pluginRepositories:
description: 'plugin 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: runs:
using: 'composite' using: 'composite'
steps: steps:
- uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2 - run: echo "::group::Checkout"
if: inputs.checkout-enabled == 'true' shell: bash
- uses: actions/checkout@v2.3.4
with: with:
fetch-depth: '${{ inputs.checkout-fetch-depth }}' fetch-depth: '${{ inputs.checkout-fetch-depth }}'
submodules: '${{ inputs.checkout-submodules }}' - run: echo "::endgroup::"
path: '${{ inputs.checkout-path }}' shell: bash
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@be666c2fcd27ec809703dec50e508c2fdc7f6654 - run: echo "::group::Setup Java"
shell: bash
- uses: actions/setup-java@v2.3.0
with: with:
overwrite-settings: false overwrite-settings: false
java-version: '${{ inputs.java-version }}' java-version: '${{ inputs.java-version }}'
distribution: '${{ inputs.java-distribution }}' distribution: '${{ inputs.java-distribution }}'
jdkFile: '${{ inputs.java-jdkFile }}' - run: echo "::endgroup::"
shell: bash
- uses: actions/cache@668228422ae6a00e4ad889ee87cd7109ec5666a7 # v5.0.4 - run: echo "::group::Setup Cache"
if: inputs.cache-enabled == 'true' shell: bash
- uses: actions/cache@v2.1.6
with: with:
path: | path: |
${{ inputs.cache-path }} ${{ inputs.cache-path }}
${{ inputs.cache-path-add }} ${{ inputs.cache-path-add }}
key: ${{ inputs.cache-prefix }}${{ runner.os }}-jdk${{ inputs.java-version }}-${{ inputs.java-distribution }}-maven${{ inputs.maven-version }}-${{ hashFiles('**/pom.xml') }} key: ${{ inputs.cache-prefix }}${{ runner.os }}-jdk${{ inputs.java-version }}-${{ inputs.java-distribution }}-maven${{ inputs.maven-version }}-${{ hashFiles('**/pom.xml') }}
restore-keys: ${{ inputs.cache-prefix }}${{ runner.os }}-jdk${{ inputs.java-version }}-${{ inputs.java-distribution }}-maven${{ inputs.maven-version }}- restore-keys: ${{ inputs.cache-prefix }}${{ runner.os }}-jdk${{ inputs.java-version }}-${{ inputs.java-distribution }}-maven${{ inputs.maven-version }}-
- run: echo "::endgroup::"
- name: Installed Maven version
run: echo "version=$(mvn -q -v)" >> $GITHUB_OUTPUT
shell: bash shell: bash
id: current-maven
- uses: stCarolas/setup-maven@12eb41b233df95d49b0c11fc1b5bc8312e5d4ce0 # v5.1 - run: echo "::group::Setup Maven Version"
if: inputs.maven-version != steps.current-maven.outputs.version shell: bash
- uses: stCarolas/setup-maven@v4.1
with: with:
maven-version: '${{ inputs.maven-version }}' maven-version: '${{ inputs.maven-version }}'
- run: echo "::endgroup::"
shell: bash
- uses: s4u/maven-settings-action@894661b3ddae382f1ae8edbeab60987e08cf0788 # v4.0.0 - run: echo "::group::Prepare Maven settings.xml"
shell: bash
- uses: s4u/maven-settings-action@v2.4.1
with: with:
servers: '${{ inputs.settings-servers}}' servers: '${{ inputs.settings-servers}}'
mirrors: '${{ inputs.settings-mirrors}}' mirrors: '${{ inputs.settings-mirrors}}'
properties: '${{ inputs.settings-properties}}' properties: '${{ inputs.settings-properties}}'
sonatypeSnapshots: '${{ inputs.settings-sonatypeSnapshots}}' sonatypeSnapshots: '${{ inputs.settings-sonatypeSnapshots}}'
proxies: '${{ inputs.settings-proxies }}' - run: echo "::endgroup::"
repositories: '${{ inputs.settings-repositories }}' shell: bash
pluginRepositories: '${{ inputs.settings-pluginRepositories }}'
githubServer: '${{ inputs.settings-githubServer }}'
path: '${{ inputs.settings-path }}'

34
pom.xml
View File

@ -36,6 +36,7 @@
<properties> <properties>
<require.maven/> <require.maven/>
<require.java/> <require.java/>
<_require.java/>
</properties> </properties>
<build> <build>
@ -43,10 +44,11 @@
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-enforcer-plugin</artifactId> <artifactId>maven-enforcer-plugin</artifactId>
<version>3.2.1</version> <version>3.0.0-M3</version>
<executions> <executions>
<execution> <execution>
<goals> <goals>
<goal>display-info</goal>
<goal>enforce</goal> <goal>enforce</goal>
</goals> </goals>
<phase>validate</phase> <phase>validate</phase>
@ -55,7 +57,7 @@
<configuration> <configuration>
<rules> <rules>
<requireJavaVersion> <requireJavaVersion>
<version>${require.java}</version> <version>${_require.java}</version>
</requireJavaVersion> </requireJavaVersion>
<requireMavenVersion> <requireMavenVersion>
<version>[${require.maven}]</version> <version>[${require.maven}]</version>
@ -65,4 +67,32 @@
</plugin> </plugin>
</plugins> </plugins>
</build> </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> </project>