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

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

Browse Source
This commit is contained in:
Tonye Jack 2022-03-24 11:18:34 -04:00 committed by GitHub
commit b58d452080
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -68,10 +68,10 @@ 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>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 current branch<br>regardless of event\_type e.g `main`, `feature/test`, `v0.0.1`.<br> | | current\_branch | string | The current branch name regardless of event\_type<br>e.g `main`, `feature/test`, `v0.0.1`. |
| default\_branch | string | The default branch e.g `main` OR `master`<br> | | 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"`. |