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

Update README.md

Browse Source
This commit is contained in:
Tonye Jack 2021-02-07 19:45:09 -05:00 committed by GitHub
parent 796c67a499
commit bd09bab9c3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -12,6 +12,19 @@ Get branch information without the `/ref/*` prefix
- name: Get branch names - name: Get branch names
uses: tj-actions/branch-names@v2 uses: tj-actions/branch-names@v2
id: branch-names id: branch-names
- name: Current branch name
if: github.event_name == 'pull_request'
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "feature/test" current PR branch.
- name: Current branch name
if: github.event_name == 'push'
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "main" the current branch that triggered the action.
- name: Get Ref brach name - name: Get Ref brach name
run: | run: |
echo "${{ steps.branch-name.outputs.ref_branch }}" echo "${{ steps.branch-name.outputs.ref_branch }}"
@ -28,6 +41,7 @@ Get branch information without the `/ref/*` prefix
run: | run: |
echo "${{ steps.branch-name.outputs.base_ref_branch }}" echo "${{ steps.branch-name.outputs.base_ref_branch }}"
# Outputs: "main" for main <- PR branch. # Outputs: "main" for main <- PR branch.
``` ```
@ -65,6 +79,7 @@ on:
| Output | type | Example | Description | | Output | type | Example | Description |
|:--------------------:|:-----------:|:---------------------:|:------------------------------------------------:| |:--------------------:|:-----------:|:---------------------:|:------------------------------------------------:|
| current_branch | `string` | `main` | Always returns the branch that triggered the workflow run. |
| base_ref_branch | `string` | `main` | The target branch of a pull request | | base_ref_branch | `string` | `main` | The target branch of a pull request |
| head_ref_branch | `string` | `feature/test` | The source branch of a pull request | | head_ref_branch | `string` | `feature/test` | The source branch of a pull request |
| ref_branch | `string` | `1/merge` OR `main` | The branch that triggered the workflow run | | ref_branch | `string` | `1/merge` OR `main` | The branch that triggered the workflow run |