Merge pull request #57 from s4u/docs

Documentation improvements

.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       matrix:
         os: [ 'ubuntu-latest', 'windows-latest', 'macOS-latest' ]
         java: [ '8', '11', '17' ]
-        maven: [ '3.6.3', '3.8.7', '3.9.0' ]
+        maven: [ '3.8.8', '3.9.4' ]
       fail-fast: false
 
     runs-on: ${{ matrix.os }}
@@ -44,10 +44,8 @@ jobs:
       - uses: actions/checkout@v3
 
       - uses: ./
-        with:
-          java-version: 8
 
-      - run: mvn -V validate -Drequire.java=8 -Drequire.maven=3.9.0
+      - run: mvn -V validate -Drequire.java=17 -Drequire.maven=3.9.4
         shell: bash
 
   test-ok:

README.md

@@ -9,37 +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)
 - [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!
+For default values you only need:
-- 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
+```yml
+    steps:
 
-This project uses [Semantic Versioning](https://semver.org/).
+      - name: Setup Maven Action
-We recommended using the latest and specific release version.
+        uses: s4u/setup-maven-action@< version >
 
-In order to keep your project dependencies up to date you can watch this repository *(Releases only)*
+      - run: mvn -V ...
-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
 
-**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-ref                 | ref                 |         |
 | checkout-persist-credentials | persist-credentials | false   |
 
 ## setup-java
 
 | params            | destination  | default |
 |-------------------|--------------|---------|
-| java-version      | java-version |         |
+| java-version      | java-version | 17      |
 | java-distribution | distribution | temurin |
 
 ## cache
@@ -69,7 +67,7 @@ So we can use for action:
 
 | params        | destination   | default |
 |---------------|---------------|---------|
-| maven-version | maven-version | 3.9.0   |
+| maven-version | maven-version | 3.9.4   |
 
 ## maven-settings-action
 
@@ -90,7 +88,7 @@ jobs:
 
     strategy:
       matrix:
-        maven: [ '3.6.3', '3.8.7', '3.9.0' ]
+        maven: [ '3.8.8', '3.9.4' ]
 
     name: Maven ${{ matrix.maven }} sample
 
@@ -105,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)

action.yml

@@ -21,11 +21,15 @@ inputs:
     default: 'false'
     required: false
 
+  checkout-ref:
+    description: 'The branch, tag, or SHA of the repository to clone'
+    required: false
 
   # java jdk params
 
   java-version:
     description: 'The Java version to set up'
+    default: '17'
     required: true
 
   java-distribution:
@@ -50,7 +54,7 @@ inputs:
   # maven version
   maven-version:
     description: 'The Maven version to set up'
-    default: '3.9.0'
+    default: '3.9.4'
     required: false
 
   # maven settings.xml
@@ -80,6 +84,7 @@ runs:
         fetch-depth: '${{ inputs.checkout-fetch-depth }}'
         path: '${{ inputs.checkout-path }}'
         persist-credentials: '${{ inputs.checkout-persist-credentials }}'
+        ref: '${{ inputs.checkout-ref }}'
 
     - uses: actions/setup-java@v3
       with: