Skip to content

Commit

Permalink
Merge pull request #57 from s4u/docs
Browse files Browse the repository at this point in the history
Documentation improvements
  • Loading branch information
slawekjaranowski authored Aug 23, 2023
2 parents f416ae1 + fe07230 commit c1ef1c9
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

- 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
:exclamation: You **should not** include above actions in your configuration - in other case those will be **called twice**. :exclamation:

# Project versioning
For default values you only need:

This project uses [Semantic Versioning](https://semver.org/).
We recommended using the latest and specific release version.
```yml
steps:

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 |
Expand Down Expand Up @@ -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)

0 comments on commit c1ef1c9

Please sign in to comment.