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

Update README.md

Browse Source
This commit is contained in:
Tonye Jack 2020-12-11 12:42:26 -05:00 committed by GitHub
parent 3b79f5be45
commit 26b1f6c3ce
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
README.md
View File

@ -26,6 +26,18 @@ Get branch information without the `/ref/*` prefix
```
### Possible usage with [actions/checkout@v2](https://github.com/actions/checkout):
```yaml
- name: Get branch names.
id: branch-names
uses: tj-actions/branch-names@v1
- uses: actions/checkout@v2
with:
ref: ${{ steps.branch-names.outputs.base_ref_branch }}
```
## Inputs
| Input | type | required | default |
@ -44,17 +56,6 @@ Get branch information without the `/ref/*` prefix
| ref_branch | `string` | `1/merge` | The branch that triggered the workflow run |
Possible usage with [actions/checkout@v2](https://github.com/actions/checkout):
```yaml
- name: Get branch names.
id: branch-names
uses: tj-actions/branch-names@v1
- uses: actions/checkout@v2
with:
ref: ${{ steps.branch-names.outputs.base_ref_branch }}
```
* Free software: [MIT license](LICENSE)