Skip to content

Commit

Permalink
Updated README.md (#236)
Browse files Browse the repository at this point in the history
Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
  • Loading branch information
jackton1 and jackton1 authored May 15, 2023
1 parent 604fda4 commit e6d6c8a
Showing 1 changed file with 13 additions and 13 deletions.
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,26 +73,26 @@ Support this project with a :star:

<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->

| OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|--------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a<br> pull request or tag e.g<br>`main` |
| current\_branch | string | The current branch name regardless<br>of event\_type e.g `main`, `feature/test` |
| default\_branch | string | The default branch name e.g<br>`main` OR `master` |
| head\_ref\_branch | string | The source branch of a<br>pull request e.g `feature/test` |
| is\_default | string | Returns `"true"` if the current<br> branch is the default else<br>`"false"`. |
| is\_tag | string | Returns `"true"` if the current<br> branch is a tag else<br>`"false"`. |
| ref\_branch | string | The branch that triggered the<br>workflow run. e.g `1/merge`, `main` |
| tag | string | The tag that triggered the<br>workflow run. e.g `v0.0.1`, `0.0.1` |
| OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|----------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a <br>pull request or tag e.g <br>`main` |
| current\_branch | string | The current branch name regardless <br>of event\_type e.g `main`, `feature/test` |
| default\_branch | string | The default branch name e.g <br>`main` OR `master` |
| head\_ref\_branch | string | The source branch of a <br>pull request e.g `feature/test` |
| is\_default | string | Returns `"true"` if the current <br>branch is the default else <br>`"false"`. |
| is\_tag | string | Returns `"true"` if the current <br>branch is a tag else <br>`"false"`. |
| ref\_branch | string | The branch that triggered the <br>workflow run. e.g `1/merge`, `main` |
| tag | string | The tag that triggered the <br>workflow run. e.g `v0.0.1`, `0.0.1` |

<!-- AUTO-DOC-OUTPUT:END -->

## Inputs

<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->

| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|------------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
| strip\_tag\_prefix | string | false | | The prefix that should be<br> stripped from the tag e.g<br> `v` -> with a tag<br>`v0.0.1` -> returns `0.0.1` |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|------------------|--------|----------|---------|----------------------------------------------------------------------------------------------------------------|
| strip\_tag\_prefix | string | false | | The prefix that should be <br>stripped from the tag e.g <br>`v` -> with a tag <br>`v0.0.1` -> returns `0.0.1` |

<!-- AUTO-DOC-INPUT:END -->

Expand Down

0 comments on commit e6d6c8a

Please sign in to comment.