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 #126 from tj-actions/chore/update-readme

Browse Source 
Updated README.md
This commit is contained in:
Tonye Jack 2022-03-22 17:24:36 -04:00 committed by GitHub
commit af5fb3398b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -65,6 +65,21 @@ Support this project with a :star:
## Outputs
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
| OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|-------------------------------------------------------------------------------------------------------------------------------|
| base\_ref\_branch | string | The target branch of a<br>pull request 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. |
| default\_branch | string | |
| head\_ref\_branch | string | The source branch of a<br>pull request e.g feature/test |
| is\_default | string | Returns "true" if the current<br>branch is the default else<br>"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<br>workflow run. e.g 1/merge, main<br> |
| tag | string | The tag that triggered the<br>workflow run. e.g v0.0.1, 0.0.1<br> |
<!-- AUTO-DOC-OUTPUT:END -->
| Output | type | Example | Description |
|:--------------------:|:------------:|:---------------------------:|:-----------------------------------------------------------------:|
| is\_default | `boolean` | `true` *OR* `false` | Detects wheter the workflow is running on a default branch |
@ -77,6 +92,14 @@ Support this project with a :star:
## Inputs
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
| 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 |
<!-- AUTO-DOC-INPUT:END -->
| Input | type | default | Description |
|:-----------------:|:---------:|:--------:|:-----------------------:|
| strip\_tag\_prefix | `string` | `''` | The tag prefix to strip <br> e.g `v0.0.1` -> `v` -> `0.0.1` |