actions/maven-gav-extractor
actions/maven-gav-extractor
1
0
Fork 0
mirror of https://github.com/andreacomo/maven-gav-extractor.git synced 2025-06-03 09:17:56 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Readme refactoring

Browse Source
This commit is contained in:
acomo 2021-02-20 23:26:13 +01:00
parent 739e5d447f
commit 622360717d
1 changed files with 12 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,12 +1,12 @@
# Maven GAV (groupId, artifactId, version) Extractor *GitHub Action*
# Maven GAV Extractor *GitHub Action*
This action extracts from `pom.xml` GAV info, i.e.:
This action extracts GAV from `pom.xml`, i.e.:
* `groupId`
* `artifactId`
* `version`
Why should I need this? For example, to **name** and **tag** a Docker image built upon your artifact
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.
## Prerequirements
@ -14,27 +14,21 @@ This action expects you to have `maven` available in your workflow environment
## Inputs
### `pom-location`
**Required** Full path to your project `pom.xml` file. Default value is POM in your project root: `${{ github.workspace }}/pom.xml`
| Name | Description | Default | Required |
| --- | --- | --- |
| `pom-location` | Full path to your project `pom.xml` file | `${{ github.workspace }}/pom.xml` | `true` |
## Outputs
### `group-id`
Group Id of your project
### `artifact-id`
Artifact Id of your project
### `version`
Version of your project
| Name | Description |
| --- | --- | --- |
| `group-id` | Group Id of your project |
| `artifact-id` | Artifact Id of your project |
| `version` | Version of your project |
## Example usage
```
```yml
name: Sample workflow
on: [push]