actions/branch-names
1
0
Fork 0
mirror of https://github.com/tj-actions/branch-names.git synced 2024-12-27 14:27:59 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md (#250)

Browse Source 
Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
This commit is contained in:
tj-actions[bot] 2023-08-23 22:17:38 -06:00 committed by GitHub
parent 309671a59e
commit 77641da3eb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -73,16 +73,16 @@ 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 |
|---------------------------------------------------------------------------------|--------|----------------------------------------------------------------------------------|
| <a name="output_base_ref_branch"></a>[base\_ref\_branch](#output_base_ref_branch) | string | The target branch of a <br>pull request or tag e.g <br>`main` |
| <a name="output_current_branch"></a>[current\_branch](#output_current_branch) | string | The current branch name regardless <br>of event\_type e.g `main`, `feature/test` |
| <a name="output_default_branch"></a>[default\_branch](#output_default_branch) | string | The default branch name e.g <br>`main` OR `master` |
| <a name="output_head_ref_branch"></a>[head\_ref\_branch](#output_head_ref_branch) | string | The source branch of a <br>pull request e.g `feature/test` |
| <a name="output_is_default"></a>[is\_default](#output_is_default) | string | Returns `"true"` if the current <br>branch is the default else <br>`"false"`. |
| <a name="output_is_tag"></a>[is\_tag](#output_is_tag) | string | Returns `"true"` if the current <br>branch is a tag else <br>`"false"`. |
| <a name="output_ref_branch"></a>[ref\_branch](#output_ref_branch) | string | The branch that triggered the <br>workflow run. e.g `1/merge`, `main` |
| <a name="output_tag"></a>[tag](#output_tag) | string | The tag that triggered the <br>workflow run. e.g `v0.0.1`, `0.0.1` |
<!-- AUTO-DOC-OUTPUT:END -->
@ -90,9 +90,9 @@ Support this project with a :star:
<!-- 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 |
|----------------------------------------------------------------------------------|--------|----------|---------|----------------------------------------------------------------------------------------------------------------|
| <a name="input_strip_tag_prefix"></a>[strip\_tag\_prefix](#input_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 -->