2021-05-27 20:34:41 +08:00
## branch-names
2021-08-23 09:16:54 +08:00
2021-11-25 03:54:11 +08:00
[![Codacy Badge ](https://api.codacy.com/project/badge/Grade/36f9e8c5e9664e0bacc7df558c13f349 )](https://app.codacy.com/gh/tj-actions/branch-names?utm_source=github.com\&utm_medium=referral\&utm_content=tj-actions/branch-names\&utm_campaign=Badge_Grade_Settings)
2022-02-02 01:00:15 +08:00
[![CI ](https://github.com/tj-actions/branch-names/workflows/CI/badge.svg )](https://github.com/tj-actions/branch-names/actions?query=workflow%3ACI) [![Update release version. ](https://github.com/tj-actions/branch-names/actions/workflows/sync-release-version.yml/badge.svg )](https://github.com/tj-actions/branch-names/actions/workflows/sync-release-version.yml) [![Public workflows that use this action. ](https://img.shields.io/endpoint?url=https%3A%2F%2Fused-by.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Dtj-actions%2Fbranch-names%26badge%3Dtrue )](https://github.com/search?o=desc\&q=tj-actions+branch-names+language%3AYAML\&s=\&type=Code)
2021-08-23 09:16:18 +08:00
2021-11-03 03:33:48 +08:00
[![Ubuntu ](https://img.shields.io/badge/Ubuntu-E95420?logo=ubuntu\&logoColor=white )](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[![Mac OS ](https://img.shields.io/badge/mac%20os-000000?logo=macos\&logoColor=F0F0F0 )](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
[![Windows ](https://img.shields.io/badge/Windows-0078D6?logo=windows\&logoColor=white )](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
2021-09-21 01:30:30 +08:00
2021-08-23 09:13:52 +08:00
<!-- ALL - CONTRIBUTORS - BADGE:START - Do not remove or modify this section -->
2021-08-23 09:16:54 +08:00
2021-11-03 03:33:48 +08:00
[![All Contributors ](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square )](#contributors-)
2021-08-23 09:16:54 +08:00
2021-08-23 09:13:52 +08:00
<!-- ALL - CONTRIBUTORS - BADGE:END -->
2020-12-11 21:15:40 +08:00
2022-03-30 12:02:19 +08:00
Get a branch or tag name without the `/ref/*` prefix
2020-12-11 21:15:40 +08:00
2021-08-26 20:34:59 +08:00
## Features
2021-08-26 20:39:46 +08:00
* Retrieve the current branch name without any prefix. (e.g. `'refs/heads/main'` -> `'main'` )
2022-03-16 16:16:27 +08:00
* Retrieve the current tag with an option to strip the prefix (e.g. `v0.0.1` -> `v` -> `0.0.1` )
2021-08-26 20:39:46 +08:00
* Detect actions triggered by non default branches
* Detect actions triggered by the default branch
2021-11-03 03:33:48 +08:00
* Supports all valid [git branch names ](https://wincent.com/wiki/Legal_Git_branch_names )
2021-08-26 20:34:59 +08:00
2021-05-27 20:34:41 +08:00
## Usage
2021-02-08 09:19:06 +08:00
2021-04-05 03:42:46 +08:00
```yaml
2021-06-07 23:25:35 +08:00
on:
push:
branches:
- main
pull_request:
branches:
- main
2022-11-13 06:49:17 +08:00
2021-04-05 03:42:46 +08:00
...
2022-11-13 06:49:17 +08:00
2021-04-05 03:42:46 +08:00
steps:
2021-07-05 19:52:59 +08:00
- name: Get branch name
2021-04-05 03:42:46 +08:00
id: branch-name
2022-08-27 23:45:50 +08:00
uses: tj-actions/branch-names@v6
2021-06-07 23:25:35 +08:00
2021-07-01 20:10:48 +08:00
- name: Running on the default branch.
if: steps.branch-name.outputs.is_default == 'true'
2021-06-01 22:01:16 +08:00
run: |
2021-07-01 20:10:48 +08:00
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'
2021-06-01 22:01:16 +08:00
run: |
2021-07-01 20:10:48 +08:00
echo "Running on pr: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on pr: feature/test".
2021-04-05 03:42:46 +08:00
```
2021-11-25 03:03:32 +08:00
If you feel generous and want to show some extra appreciation:
Support this project with a :star:
[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee]
[buymeacoffee]: https://www.buymeacoffee.com/jackton1
[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png
2021-07-05 19:52:36 +08:00
## Outputs
2022-03-23 05:21:35 +08:00
<!-- AUTO - DOC - OUTPUT:START - Do not remove or modify this section -->
2022-09-24 14:39:48 +08:00
| OUTPUT | TYPE | DESCRIPTION |
|-----------------|--------|--------------------------------------------------------------------------------|
2022-10-30 11:38:49 +08:00
| base\_ref\_branch | string | The target branch of a pull request< br > or tag e.g `main` |
2022-09-24 14:39:48 +08:00
| current\_branch | string | The current branch name regardless of event\_type< br > e.g `main` , `feature/test` |
2022-10-30 11:38:49 +08:00
| default\_branch | string | The default branch name e.g `main` OR< br > `master` |
| head\_ref\_branch | string | The source branch of a pull request< br > e.g `feature/test` |
| is\_default | string | Returns `"true"` if the current branch is< br > the default else `"false"` . |
| is\_tag | string | Returns `"true"` if the current branch is< br > a tag else `"false"` . |
| ref\_branch | string | The branch that triggered the workflow run.< br > e.g `1/merge` , `main` |
| tag | string | The tag that triggered the workflow run.< br > e.g `v0.0.1` , `0.0.1` |
2022-03-23 05:21:35 +08:00
<!-- AUTO - DOC - OUTPUT:END -->
2021-07-05 19:52:36 +08:00
## Inputs
2022-03-23 05:21:35 +08:00
<!-- AUTO - DOC - INPUT:START - Do not remove or modify this section -->
2022-03-23 05:43:01 +08:00
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|------------------|--------|----------|---------|----------------------------------------------------------------------------------------------|
2022-10-30 11:38:49 +08:00
| strip\_tag\_prefix | string | false | | The prefix that should be stripped from< br > the tag e.g `v0.0.1` -> `(strip v)` < br > -> `0.0.1` |
2022-03-23 05:21:35 +08:00
<!-- AUTO - DOC - INPUT:END -->
2021-07-06 05:24:11 +08:00
## Events
2021-07-06 05:25:13 +08:00
* `push*`
2021-04-05 03:42:46 +08:00
2020-12-11 21:15:40 +08:00
```yaml
2021-07-06 05:24:11 +08:00
on:
push:
branches:
- main
2020-12-11 21:15:40 +08:00
...
steps:
2020-12-11 23:39:03 +08:00
- name: Get branch names
2021-02-13 04:02:53 +08:00
id: branch-name
2022-08-27 23:45:50 +08:00
uses: tj-actions/branch-names@v6
2021-05-27 20:17:23 +08:00
2021-07-06 05:24:11 +08:00
- name: Current branch name
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "main" the branch that triggered the push event.
2021-02-14 21:19:07 +08:00
- name: Running on the default branch.
2021-02-16 02:19:33 +08:00
if: steps.branch-name.outputs.is_default == 'true'
2021-02-14 21:19:07 +08:00
run: |
2021-02-16 02:19:33 +08:00
echo "Running on default: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on default: main".
2021-02-14 21:19:07 +08:00
2021-07-06 05:24:11 +08:00
- name: Running on the default branch (i.e non tag based branch).
2021-05-27 20:17:23 +08:00
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".
2021-07-06 18:28:07 +08:00
- name: Get Ref brach name
run: |
echo "${{ steps.branch-name.outputs.ref_branch }}"
# Outputs: "main"
2022-03-23 05:47:12 +08:00
- name: Default branch name
run: |
echo "${{ steps.branch-name.outputs.default_branch }}"
# Outputs: "main" the default branch.
2021-07-06 05:24:11 +08:00
```
2021-07-06 05:25:13 +08:00
* `pull_request*`
2021-07-06 05:24:11 +08:00
```yaml
on:
pull_request:
branches:
- main
...
steps:
- name: Get branch names
id: branch-name
2022-08-27 23:45:50 +08:00
uses: tj-actions/branch-names@v6
2021-02-08 08:45:09 +08:00
- name: Current branch name
run: |
echo "${{ steps.branch-name.outputs.current_branch }}"
2021-02-09 06:12:17 +08:00
# Outputs: "feature/test" current PR branch.
2021-07-06 05:24:11 +08:00
- name: Running on a non tag based branch and a PR branch.
if: steps.branch-name.outputs.is_default == 'false'
2021-02-08 08:45:09 +08:00
run: |
2021-07-06 05:24:11 +08:00
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on branch: feature/test".
2021-02-08 08:45:09 +08:00
2021-07-06 05:24:11 +08:00
- 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'
2020-12-11 21:52:52 +08:00
run: |
2021-07-06 05:24:11 +08:00
echo "Running on branch: ${{ steps.branch-name.outputs.current_branch }}"
# Outputs: "Running on branch: feature/test".
2021-07-06 18:28:07 +08:00
2022-03-23 05:47:12 +08:00
- name: Get Ref branch name
2021-07-06 18:28:07 +08:00
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".
2022-03-23 05:47:12 +08:00
- name: Default branch name
run: |
echo "${{ steps.branch-name.outputs.default_branch }}"
# Outputs: "main" the default branch.
2021-07-06 05:24:11 +08:00
```
2020-12-11 21:52:52 +08:00
2021-07-06 05:25:13 +08:00
* `tag*`
2021-07-06 05:24:11 +08:00
```yaml
on:
push:
tags:
- '*'
2020-12-11 21:52:52 +08:00
2021-07-06 05:24:11 +08:00
...
steps:
- name: Get branch names
id: branch-name
2022-08-27 23:45:50 +08:00
uses: tj-actions/branch-names@v6
2021-07-06 05:24:11 +08:00
- name: Running on a tag branch.
if: steps.branch-name.outputs.is_tag == 'true'
2020-12-11 21:52:52 +08:00
run: |
2021-07-06 05:24:11 +08:00
echo "Running on: ${{ steps.branch-name.outputs.tag }}"
# Outputs: "Running on: v0.0.1".
2021-04-24 18:41:16 +08:00
- name: Get the current tag
2021-07-13 15:35:03 +08:00
if: steps.branch-name.outputs.is_tag == 'true' # Replaces: startsWith(github.ref, 'refs/tags/')
2021-04-24 18:41:16 +08:00
run: |
echo "${{ steps.branch-name.outputs.tag }}"
# Outputs: "v0.0.1" OR "0.0.1"
2020-12-11 21:15:40 +08:00
```
2020-12-12 01:42:26 +08:00
### Possible usage with [actions/checkout@v2](https://github.com/actions/checkout):
```yaml
2020-12-12 05:18:42 +08:00
on:
pull_request:
branches:
- develop
jobs:
test:
runs-on: ubuntu-latest
steps:
2020-12-12 01:42:26 +08:00
- name: Get branch names.
id: branch-names
2022-08-27 23:45:50 +08:00
uses: tj-actions/branch-names@v6
2020-12-12 01:42:26 +08:00
- uses: actions/checkout@v2
with:
2021-06-24 05:09:32 +08:00
ref: ${{ steps.branch-names.outputs.head_ref_branch }}
2020-12-12 01:42:26 +08:00
```
2021-06-06 04:54:10 +08:00
* Free software: [MIT license ](LICENSE )
2021-06-06 04:53:34 +08:00
2021-05-27 20:34:41 +08:00
## Credits
2020-12-11 21:15:40 +08:00
This package was created with [Cookiecutter ](https://github.com/cookiecutter/cookiecutter ).
2021-05-27 20:34:41 +08:00
## Report Bugs
2020-12-11 21:15:40 +08:00
2020-12-11 23:26:26 +08:00
Report bugs at https://github.com/tj-actions/branch-names/issues.
2020-12-11 21:15:40 +08:00
If you are reporting a bug, please include:
2021-05-27 20:34:41 +08:00
* Your operating system name and version.
* Any details about your workflow that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.
2021-08-23 09:13:52 +08:00
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL - CONTRIBUTORS - LIST:START - Do not remove or modify this section -->
2021-08-23 09:16:54 +08:00
2021-08-23 09:13:52 +08:00
<!-- prettier - ignore - start -->
2021-08-23 09:16:54 +08:00
2021-08-23 09:13:52 +08:00
<!-- markdownlint - disable -->
2021-08-23 09:16:54 +08:00
2021-08-23 09:13:52 +08:00
< table >
< tr >
< td align = "center" > < a href = "https://github.com/loarca" > < img src = "https://avatars.githubusercontent.com/u/22898638?v=4?s=100" width = "100px;" alt = "" / > < br / > < sub > < b > Alejandro Loarca< / b > < / sub > < / a > < br / > < a href = "https://github.com/tj-actions/branch-names/commits?author=loarca" title = "Code" > 💻< / a > < / td >
< / tr >
< / table >
<!-- markdownlint - restore -->
2021-08-23 09:16:54 +08:00
2021-08-23 09:13:52 +08:00
<!-- prettier - ignore - end -->
<!-- ALL - CONTRIBUTORS - LIST:END -->
2021-08-23 09:16:18 +08:00
This project follows the [all-contributors ](https://github.com/all-contributors/all-contributors ) specification. Contributions of any kind welcome!