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

Merge pull request #127 from tj-actions/chore/update-readme

Browse Source
This commit is contained in:
Tonye Jack 2022-03-22 17:33:56 -04:00 committed by GitHub
commit 9cd06d955f
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

20
README.md
View File

@ -68,15 +68,15 @@ Support this project with a :star:
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section --> <!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
| OUTPUT | TYPE | DESCRIPTION | | OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|-------------------------------------------------------------------------------------------------------------------------------| |-----------------|--------|----------------------------------------------------------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a<br>pull request e.g main | | base\_ref\_branch | string | The target branch of a pull request<br>e.g `main` |
| current\_branch | string | Returns the value of the<br>current branch which is consistent<br>regardless of event\_type e.g main,<br>feature/test, v0.0.1. | | current\_branch | string | Returns the value of the current branch<br>which is consistent regardless of event\_type e.g<br>`main`, `feature/test`, `v0.0.1`. |
| default\_branch | string | | | default\_branch | string | |
| head\_ref\_branch | string | The source branch of a<br>pull request e.g feature/test | | head\_ref\_branch | string | The source branch of a pull request<br>e.g `feature/test` |
| is\_default | string | Returns "true" if the current<br>branch is the default else<br>"false". | | is\_default | string | Returns `"true"` if the current branch is<br>the default else `"false"`. |
| is\_tag | string | Returns "true" if the current<br>branch is a tag else<br>"false". | | is\_tag | string | Returns `"true"` if the current branch is<br>a tag else `"false"`. |
| ref\_branch | string | The branch that triggered the<br>workflow run. e.g 1/merge, main<br> | | ref\_branch | string | The branch that triggered the workflow run.<br>e.g `1/merge`, `main` |
| tag | string | The tag that triggered the<br>workflow run. e.g v0.0.1, 0.0.1<br> | | tag | string | The tag that triggered the workflow run.<br>e.g `v0.0.1`, `0.0.1` |
<!-- AUTO-DOC-OUTPUT:END --> <!-- AUTO-DOC-OUTPUT:END -->
@ -85,8 +85,8 @@ Support this project with a :star:
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section --> <!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | | INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|------------------|--------|----------|---------|----------------------------------------------------------------| |------------------|--------|----------|---------|---------------------------------------------------------------|
| strip\_tag\_prefix | string | false | | The tag prefix to strip<br>e.g v0.0.1 -> (strip v)<br>-> 0.0.1 | | strip\_tag\_prefix | string | false | | The tag prefix to strip e.g `v0.0.1<br>-> (strip v) -> 0.0.1` |
<!-- AUTO-DOC-INPUT:END --> <!-- AUTO-DOC-INPUT:END -->