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

Update README.md

Browse Source
This commit is contained in:
Tonye Jack 2022-03-16 04:16:27 -04:00 committed by GitHub
parent 12c4cfe20c
commit ddd733ff5a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -18,7 +18,7 @@ Get branch or tag information without the `/ref/*` prefix
## Features ## Features
* Retrieve the current branch name without any prefix. (e.g. `'refs/heads/main'` -> `'main'`) * Retrieve the current branch name without any prefix. (e.g. `'refs/heads/main'` -> `'main'`)
* Retrieve the current tag with an option to strip the "v" prefix (e.g. `'refs/tags/v1.0.0'` -> `'v1.0.0'` OR `'1.0.0'`) * Retrieve the current tag with an option to strip the prefix (e.g. `v0.0.1` -> `v` -> `0.0.1`)
* Detect actions triggered by non default branches * Detect actions triggered by non default branches
* Detect actions triggered by the default branch * Detect actions triggered by the default branch
* Supports all valid [git branch names](https://wincent.com/wiki/Legal_Git_branch_names) * Supports all valid [git branch names](https://wincent.com/wiki/Legal_Git_branch_names)
@ -79,7 +79,7 @@ Support this project with a :star:
| Input | type | default | Description | | Input | type | default | Description |
|:-----------------:|:---------:|:--------:|:-----------------------:| |:-----------------:|:---------:|:--------:|:-----------------------:|
| strip\_tag\_prefix | `string` | `''` | The tag prefix to strip <br> *i.e `v0.0.1` -> `v` -> `0.0.1`* | | strip\_tag\_prefix | `string` | `''` | The tag prefix to strip <br> e.g `v0.0.1` -> `v` -> `0.0.1` |
## Events ## Events