2021-05-27 12:34:41 +00:00
## branch-names
2020-12-11 08:15:40 -05:00
2021-06-09 21:00:36 -04:00
[](https://github.com/tj-actions/branch-names/actions?query=workflow%3ACI) [](https://github.com/tj-actions/branch-names/actions/workflows/sync-release-version.yml) [](https://github.com/search?o=desc\&q=tj-actions+branch-names+language%3AYAML\&s=\&type=Code)
2021-01-06 19:46:26 -05:00
2021-04-24 06:54:35 -04:00
Get branch or tag information without the `/ref/*` prefix
2020-12-11 08:15:40 -05:00
2021-06-22 21:19:22 -04:00
## Supported Platforms
* [`ubuntu-*` ](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on )
* [`macos-*` ](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on )
* [`windows-*` ](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on )
2021-02-07 20:19:06 -05:00
## Outputs
2021-02-13 05:44:40 -05:00
| Output | type | Example | Description |
|:--------------------:|:------------:|:---------------------------:|:-----------------------------------------------------------------:|
2021-06-10 20:50:10 -04:00
| 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 |
2021-02-13 05:44:40 -05:00
| 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 |
2021-05-27 08:17:23 -04:00
| tag | `string` | `v0.0.1` *OR* `0.0.1` | The tag that triggered the workflow run |
2021-02-07 20:19:06 -05:00
2021-04-24 20:33:50 -04:00
## Inputs
| Input | type | default | Description |
|:-----------------:|:---------:|:--------:|:-----------------------:|
| strip_tag_prefix | `string` | `''` | The tag prefix to strip < br > *i.e `v0.0.1` -> `v` -> `0.0.1`* |
2021-05-27 12:34:41 +00:00
## Usage
2021-02-07 20:19:06 -05:00
2021-04-04 15:42:46 -04:00
```yaml
2021-06-07 11:25:35 -04:00
on:
push:
branches:
- main
pull_request:
branches:
- main
2021-04-04 15:42:46 -04:00
...
steps:
- name: Get branch names
id: branch-name
2021-05-27 08:40:24 -04:00
uses: tj-actions/branch-names@v4 .3
2021-06-07 11:25:35 -04:00
2021-06-01 10:01:16 -04:00
- name: Current branch name
2021-06-07 11:25:35 -04:00
if: github.event_name == 'push'
2021-06-01 10:01:16 -04:00
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
2021-06-07 11:25:35 -04:00
# Outputs: "main" the branch that triggered the push event.
2021-06-01 10:01:16 -04:00
- name: Current branch name
2021-06-07 11:25:35 -04:00
if: github.event_name == 'pull_request'
2021-06-01 10:01:16 -04:00
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
2021-06-07 11:25:35 -04:00
# Outputs: "feature/test" the current PR branch.
2021-04-04 15:42:46 -04:00
```
## Examples
2020-12-11 08:15:40 -05:00
```yaml
...
steps:
2020-12-11 10:39:03 -05:00
- name: Get branch names
2021-02-12 15:02:53 -05:00
id: branch-name
2021-05-27 08:40:24 -04:00
uses: tj-actions/branch-names@v4 .3
2021-05-27 08:17:23 -04:00
2021-02-14 08:19:07 -05:00
- name: Running on the default branch.
2021-02-15 13:19:33 -05:00
if: steps.branch-name.outputs.is_default == 'true'
2021-02-14 08:19:07 -05:00
run: |
2021-02-15 13:19:33 -05:00
echo "Running on default: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on default: main".
2021-02-14 08:19:07 -05:00
- name: Running on a pull request branch.
2021-02-15 13:19:33 -05:00
if: steps.branch-name.outputs.is_default == 'false'
2021-02-14 08:19:07 -05:00
run: |
2021-02-15 13:19:33 -05:00
echo "Running on pr: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on pr: feature/test".
2021-05-27 08:17:23 -04:00
- name: Running on a tag branch.
if: steps.branch-name.outputs.is_tag == 'true'
run: |
echo "Running on tag: ${{ steps.branch-name.outputs.tag }}"
# Outputs: "Running on tag: v0.0.1".
- name: Running on a non tag based branch and the default 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: Running on a non tag based branch and a PR 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".
2021-02-07 19:45:09 -05:00
- name: Current branch name
if: github.event_name == 'pull_request'
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
2021-02-08 17:12:17 -05:00
# Outputs: "feature/test" current PR branch.
2021-02-07 19:45:09 -05:00
- name: Current branch name
if: github.event_name == 'push'
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
2021-02-15 13:05:44 -05:00
# Outputs: "main" the branch that triggered the push event.
2021-02-07 19:45:09 -05:00
2020-12-11 08:52:52 -05:00
- name: Get Ref brach name
run: |
2020-12-11 16:37:11 -05:00
echo "${{ steps.branch-name.outputs.ref_branch }}"
2020-12-11 16:37:34 -05:00
# Outputs: "main" for non PR branches | "1/merge" for a PR branch
2020-12-11 08:52:52 -05:00
- name: Get Head Ref branch name
if: github.event_name == 'pull_request'
2020-12-11 08:21:28 -05:00
run: |
2020-12-11 16:37:11 -05:00
echo "${{ steps.branch-name.outputs.head_ref_branch }}"
2020-12-11 16:37:34 -05:00
# Outputs: "feature/test" current PR branch.
2020-12-11 08:52:52 -05:00
- name: Get Base Ref branch name
if: github.event_name == 'pull_request'
run: |
2020-12-11 16:37:11 -05:00
echo "${{ steps.branch-name.outputs.base_ref_branch }}"
2020-12-11 16:37:34 -05:00
# Outputs: "main" for main < - PR branch .
2021-04-24 06:41:16 -04:00
- name: Get the current tag
if: startsWith(github.ref, 'refs/tags/')
run: |
echo "${{ steps.branch-name.outputs.tag }}"
# Outputs: "v0.0.1" OR "0.0.1"
2020-12-11 08:15:40 -05:00
```
2020-12-11 12:42:26 -05:00
### Possible usage with [actions/checkout@v2](https://github.com/actions/checkout):
```yaml
2020-12-11 16:18:42 -05:00
on:
pull_request:
branches:
- develop
jobs:
test:
runs-on: ubuntu-latest
steps:
2020-12-11 12:42:26 -05:00
- name: Get branch names.
id: branch-names
2021-05-27 08:40:24 -04:00
uses: tj-actions/branch-names@v4 .3
2020-12-11 12:42:26 -05:00
- uses: actions/checkout@v2
with:
ref: ${{ steps.branch-names.outputs.base_ref_branch }}
```
2021-06-05 20:54:10 +00:00
* Free software: [MIT license ](LICENSE )
2021-06-05 16:53:34 -04:00
If you feel generous and want to show some extra appreciation:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
2021-06-05 20:54:10 +00:00
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
2020-12-11 12:42:26 -05:00
2021-05-27 12:34:41 +00:00
## Credits
2020-12-11 08:15:40 -05:00
This package was created with [Cookiecutter ](https://github.com/cookiecutter/cookiecutter ).
2021-05-27 12:34:41 +00:00
## Report Bugs
2020-12-11 08:15:40 -05:00
2020-12-11 10:26:26 -05:00
Report bugs at https://github.com/tj-actions/branch-names/issues.
2020-12-11 08:15:40 -05:00
If you are reporting a bug, please include:
2021-05-27 12:34:41 +00:00
* Your operating system name and version.
* Any details about your workflow that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.