Skip to content

Commit

Permalink
Merge pull request #22 from WyriHaximus/update-readme-on-inputs-and-o…
Browse files Browse the repository at this point in the history
…utputs

Updated readme on inputs and outputs
  • Loading branch information
WyriHaximus authored Apr 23, 2021
2 parents 638edde + cb627b4 commit 8a0e045
Showing 1 changed file with 14 additions and 2 deletions.
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,22 @@ Github Action that gets the latest tag from git

![Example output showing this action in action](images/output.png)

## Input

By default, this action will fail if no tag can be found, however, it accepts a `fallback` tag that will be used when no
tag can be found. Keep in mind that when this action is used in a workflow that has no `.git` directory, it will still
fail, and the fallback tag isn't used.

* `fallback`: `1.0.0`

## Output

This action has only one output, namely, `tag` for the latest tag this action finds.
When no tag is found or another error occurs it exits with code `1`.
This action has two outputs, `tag` for the found tag, or the fallback. And, `timestamp` as a UNIX Epoch timestmap for
when the tag was created, or when no tag is found, and a fallback tag has be specific is provides the timestamp of
action execution.

* `tag`: `1.2.3`
* `timestamp`: `123`

## Example

Expand Down

0 comments on commit 8a0e045

Please sign in to comment.