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

Updated README.md

Browse Source
This commit is contained in:
jackton1 2022-09-24 06:39:48 +00:00 committed by GitHub
parent b5fee667e4
commit 93968fdcda
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -67,16 +67,16 @@ 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 pull request<br>or the source branch for a tag<br>e.g `main` | | 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` | | 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` | | 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` | | 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\_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"`. | | 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` | | 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` | | 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 -->