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

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

Browse Source 
Updated README.md
This commit is contained in:
repo-ranger[bot] 2022-12-31 05:12:54 +00:00 committed by GitHub
commit 6d86e5894d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -71,14 +71,14 @@ Support this project with a :star:
| OUTPUT | TYPE | DESCRIPTION | | OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|--------------------------------------------------------------------------------| |-----------------|--------|--------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a pull request<br>or tag e.g `main` | | 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 event\_type<br>e.g `main`, `feature/test` | | 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` OR<br>`master` | | default\_branch | string | The default branch name e.g `main`<br>OR `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<br>request 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<br>is 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<br>is 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<br>run. 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<br>run. e.g `v0.0.1`, `0.0.1` |
<!-- AUTO-DOC-OUTPUT:END --> <!-- AUTO-DOC-OUTPUT:END -->
@ -86,9 +86,9 @@ 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 prefix that should be stripped from<br>the tag e.g `v0.0.1` -> `(strip v)`<br>-> `0.0.1` | | 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 --> <!-- AUTO-DOC-INPUT:END -->