Update documentation

This commit is contained in:
Harald Pehl 2022-09-21 15:20:46 +02:00 committed by GitHub
parent 115a2c0d66
commit 0ceddd3ac8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -7,6 +7,7 @@ This *GitHub Action* extracts GAV from `pom.xml`, i.e.:
* `groupId` * `groupId`
* `artifactId` * `artifactId`
* `version` * `version`
* `name`
Why should I need this? For example, to **name** and **tag** a Docker image built upon your artifact or **pass as parameters** to a dispatched workflow. Why should I need this? For example, to **name** and **tag** a Docker image built upon your artifact or **pass as parameters** to a dispatched workflow.
@ -27,6 +28,7 @@ This action expects you to have `maven` available in your workflow environment
| `group-id` | Group Id of your project | | `group-id` | Group Id of your project |
| `artifact-id` | Artifact Id of your project | | `artifact-id` | Artifact Id of your project |
| `version` | Version of your project | | `version` | Version of your project |
| `name` | Name of your project |
## Example usage ## Example usage
@ -53,5 +55,6 @@ jobs:
echo ${{ steps.extract.outputs.group-id }} echo ${{ steps.extract.outputs.group-id }}
echo ${{ steps.extract.outputs.artifact-id }} echo ${{ steps.extract.outputs.artifact-id }}
echo ${{ steps.extract.outputs.version }} echo ${{ steps.extract.outputs.version }}
echo ${{ steps.extract.outputs.name }}
shell: bash shell: bash
``` ```