actions/branch-names
1
0
Fork 0
mirror of https://github.com/tj-actions/branch-names.git synced 2024-11-23 20:53:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Updated README.md (#232)

Browse Source 
Co-authored-by: jackton1 <jackton1@users.noreply.github.com>
This commit is contained in:
Tonye Jack 2023-05-01 03:10:04 -06:00 committed by GitHub
parent eebd24b22a
commit 1eb24dd344
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@ -75,14 +75,14 @@ Support this project with a :star:
| OUTPUT | TYPE | DESCRIPTION | | OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|--------------------------------------------------------------------------------| |-----------------|--------|--------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a pull<br>request or tag e.g `main` | | 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 of<br>event\_type e.g `main`, `feature/test` | | 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 `main`<br>OR `master` | | default\_branch | string | The default branch name e.g<br>`main` OR `master` |
| head\_ref\_branch | string | The source branch of a pull<br>request e.g `feature/test` | | head\_ref\_branch | string | The source branch of a<br>pull request e.g `feature/test` |
| is\_default | string | Returns `"true"` if the current branch<br>is the default else `"false"`. | | is\_default | string | Returns `"true"` if the current<br> branch is the default else<br>`"false"`. |
| is\_tag | string | Returns `"true"` if the current branch<br>is a tag else `"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 workflow<br>run. e.g `1/merge`, `main` | | ref\_branch | string | The branch that triggered the<br>workflow run. e.g `1/merge`, `main` |
| tag | string | The tag that triggered the workflow<br>run. e.g `v0.0.1`, `0.0.1` | | tag | string | The tag that triggered the<br>workflow run. e.g `v0.0.1`, `0.0.1` |
<!-- AUTO-DOC-OUTPUT:END --> <!-- AUTO-DOC-OUTPUT:END -->
@ -92,7 +92,7 @@ Support this project with a :star:
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | | INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|------------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------| |------------------|--------|----------|---------|--------------------------------------------------------------------------------------------------------------|
| strip\_tag\_prefix | string | false | | The prefix that should be stripped<br> from the tag e.g `v` -><br> with a tag `v0.0.1` -> returns<br>`0.0.1` | | 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 --> <!-- AUTO-DOC-INPUT:END -->