Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updated README.md #208

Merged
merged 1 commit into from
Dec 31, 2022
Merged

Updated README.md #208

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,24 +71,24 @@ Support this project with a :star:

| OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|--------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a pull request<br>or tag e.g `main` |
| current\_branch | string | The current branch name regardless of event\_type<br>e.g `main`, `feature/test` |
| default\_branch | string | The default branch name e.g `main` OR<br>`master` |
| head\_ref\_branch | string | The source branch of a pull request<br>e.g `feature/test` |
| is\_default | string | Returns `"true"` if the current branch is<br>the default else `"false"`. |
| is\_tag | string | Returns `"true"` if the current branch is<br>a tag else `"false"`. |
| ref\_branch | string | The branch that triggered the workflow run.<br>e.g `1/merge`, `main` |
| tag | string | The tag that triggered the workflow run.<br>e.g `v0.0.1`, `0.0.1` |
| base\_ref\_branch | string | The target branch of a pull<br>request or tag e.g `main` |
| current\_branch | string | The current branch name regardless of<br>event\_type e.g `main`, `feature/test` |
| default\_branch | string | The default branch name e.g `main`<br>OR `master` |
| head\_ref\_branch | string | The source branch of a pull<br>request e.g `feature/test` |
| is\_default | string | Returns `"true"` if the current branch<br>is the default else `"false"`. |
| is\_tag | string | Returns `"true"` if the current branch<br>is a tag else `"false"`. |
| ref\_branch | string | The branch that triggered the workflow<br>run. e.g `1/merge`, `main` |
| tag | string | The tag that triggered the workflow<br>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 stripped from<br>the tag e.g `v0.0.1` -> `(strip v)`<br>-> `0.0.1` |
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|------------------|--------|----------|---------|-----------------------------------------------------------------------------------------------|
| strip\_tag\_prefix | string | false | | The prefix that should be stripped<br> from the tag e.g `v0.0.1` -><br>`(strip v)` -> `0.0.1` |

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

Expand Down