actions/setup-maven-action
1
0
Fork 0
mirror of https://github.com/s4u/setup-maven-action.git synced 2026-02-12 00:05:30 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation improvements

Browse Source
This commit is contained in:
Slawomir Jaranowski
2023-08-23 22:57:55 +02:00
parent 7b66d0ca2e
commit fe0723070c
1 changed files with 23 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
README.md
View File

@ -9,24 +9,21 @@ 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.
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).
- name: Setup Maven Action
uses: s4u/setup-maven-action@< version >
- 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 |
@ -106,6 +103,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)