Get branch or tag information without the /ref/*
prefix
on:
push:
branches:
- main
pull_request:
branches:
- main
...
steps:
- name: Get branch name
id: branch-name
uses: tj-actions/branch-names@v4.5
- name: Running on the default branch.
if: steps.branch-name.outputs.is_default == 'true'
run: |
echo "Running on default: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on default: main".
- name: Running on a pull request branch.
if: steps.branch-name.outputs.is_default == 'false'
run: |
echo "Running on pr: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on pr: feature/test".
Output | type | Example | Description |
---|---|---|---|
is_default | boolean |
true OR false |
Detects wheter the workflow is running on a default branch |
is_tag | boolean |
true OR false |
Detects wheter the workflow is running on a tag branch |
current_branch | string |
main OR feature/test |
Always returns a valid branch name for a triggered workflow run. |
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 |
ref_branch | string |
1/merge OR main |
The branch that triggered the workflow run |
tag | string |
v0.0.1 OR 0.0.1 |
The tag that triggered the workflow run |
Input | type | default | Description |
---|---|---|---|
strip_tag_prefix | string |
'' |
The tag prefix to strip i.e v0.0.1 -> v -> 0.0.1 |
push*
on:
push:
branches:
- main
...
steps:
- name: Get branch names
id: branch-name
uses: tj-actions/branch-names@v4.5
- name: Current branch name
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "main" the branch that triggered the push event.
- name: Running on the default branch.
if: steps.branch-name.outputs.is_default == 'true'
run: |
echo "Running on default: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on default: main".
- name: Running on the default branch (i.e non tag based branch).
if: steps.branch-name.outputs.is_tag == 'false' && steps.branch-name.outputs.is_default == 'true'
run: |
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on branch: main".
- name: Get Ref brach name
run: |
echo "${{ steps.branch-name.outputs.ref_branch }}"
# Outputs: "main"
pull_request*
on:
pull_request:
branches:
- main
...
steps:
- name: Get branch names
id: branch-name
uses: tj-actions/branch-names@v4.5
- name: Current branch name
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "feature/test" current PR branch.
- name: Running on a non tag based branch and a PR branch.
if: steps.branch-name.outputs.is_default == 'false'
run: |
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on branch: feature/test".
- name: Running on a pull request (i.e non tag based branch).
if: steps.branch-name.outputs.is_tag == 'false' && steps.branch-name.outputs.is_default == 'false'
run: |
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on branch: feature/test".
- name: Get Ref brach name
run: |
echo "${{ steps.branch-name.outputs.ref_branch }}"
# Outputs: "1/merge"
- name: Get Head Ref branch name (i.e The current pull request branch)
run: |
echo "${{ steps.branch-name.outputs.head_ref_branch }}"
# Outputs: "feature/test" current PR branch.
- name: Get Base Ref branch name (i.e The target of a pull request.)
run: |
echo "${{ steps.branch-name.outputs.base_ref_branch }}"
# Outputs: "main".
tag*
on:
push:
tags:
- '*'
...
steps:
- name: Get branch names
id: branch-name
uses: tj-actions/branch-names@v4.5.
- name: Running on a tag branch.
if: steps.branch-name.outputs.is_tag == 'true'
run: |
echo "Running on: ${{ steps.branch-name.outputs.tag }}"
# Outputs: "Running on: v0.0.1".
- name: Get the current tag
if: steps.branch-name.outputs.is_tag == 'true' # Replaces: startsWith(github.ref, 'refs/tags/')
run: |
echo "${{ steps.branch-name.outputs.tag }}"
# Outputs: "v0.0.1" OR "0.0.1"
Possible usage with actions/checkout@v2:
on:
pull_request:
branches:
- develop
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Get branch names.
id: branch-names
uses: tj-actions/branch-names@v4.5
- uses: actions/checkout@v2
with:
ref: ${{ steps.branch-names.outputs.head_ref_branch }}
- Free software: MIT license
If you feel generous and want to show some extra appreciation:
Support me with a ⭐
This package was created with Cookiecutter.
Report bugs at https://github.com/tj-actions/branch-names/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your workflow that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.