Skip to content

Commit

Permalink
Fix README.md (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
yoanm authored Aug 24, 2024
1 parent 9c9bcb0 commit de5e348
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Lightweight composite github action managing `vX` and `vX.Y` tags for a github a
Designed to act upon created or edited github releases, action will create or override `vX` and `vX.Y` tags based on the provided tag.

> [!NOTE]
> **Action will also override the original tag**, in order to keep it as latest tag !
> **Action will also override the original tag** (reference and the message stay as is though), in order to keep it as latest tag !
>
> Otherwise, when creating a new github releases with an automatically generated changelog, `vX` or `vX.Y` tag will be picked as previous tag rather than the expected previous `vX.Y.Z` tag.
Expand Down Expand Up @@ -48,9 +48,10 @@ jobs:
- `git-email`: Default to `github-actions[bot]@users.noreply.github.com`.

_Git user email is required when creating tag with a message._
- `git-name`: Default to `github-actions`.
- `git-name`: Default to `github-actions[bot]`.

_Git user name is required when creating tag with a message._
- `working-directory`: Directory to the Git repository to tag. Default to `${{ github.workspace }}`.

## Outputs
- `minor-tag`: Minor tag created (e.g. `vX.Y`)
Expand Down

0 comments on commit de5e348

Please sign in to comment.