mirror of
https://github.com/tj-actions/branch-names.git
synced 2024-11-24 08:33:51 +08:00
275 lines
10 KiB
Markdown
275 lines
10 KiB
Markdown
## branch-names
|
|
|
|
[](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)
|
|
[](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)
|
|
|
|
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
|
|
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
|
|
[](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on)
|
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
|
|
|
[](#contributors-)
|
|
|
|
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
|
|
|
Get a branch or tag name without the `/ref/*` prefix
|
|
|
|
## Features
|
|
|
|
* Retrieve the current branch name without any prefix. (e.g. `'refs/heads/main'` -> `'main'`)
|
|
* Retrieve the current tag with an option to strip the prefix (e.g. `v0.0.1` -> `v` -> `0.0.1`)
|
|
* Detect actions triggered by non default branches
|
|
* Detect actions triggered by the default branch
|
|
* Supports all valid [git branch names](https://wincent.com/wiki/Legal_Git_branch_names)
|
|
|
|
## Usage
|
|
|
|
```yaml
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
|
|
...
|
|
steps:
|
|
- name: Get branch name
|
|
id: branch-name
|
|
uses: tj-actions/branch-names@v5.2
|
|
|
|
- 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".
|
|
```
|
|
|
|
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
|
|
|
|
## Outputs
|
|
|
|
<!-- AUTO-DOC-OUTPUT:START - Do not remove or modify this section -->
|
|
|
|
| OUTPUT | TYPE | DESCRIPTION |
|
|
|-----------------|--------|-------------------------------------------------------------------------------------------|
|
|
| base\_ref\_branch | string | The target branch of a pull request<br>e.g `main` |
|
|
| current\_branch | string | The current branch name regardless of event\_type<br>e.g `main`, `feature/test`, `v0.0.1`. |
|
|
| 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` |
|
|
|
|
<!-- AUTO-DOC-OUTPUT:END -->
|
|
|
|
## Inputs
|
|
|
|
<!-- AUTO-DOC-INPUT:START - Do not remove or modify this section -->
|
|
|
|
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|
|
|------------------|--------|----------|---------|----------------------------------------------------------------------------------------------|
|
|
| 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` |
|
|
|
|
<!-- AUTO-DOC-INPUT:END -->
|
|
|
|
## Events
|
|
|
|
* `push*`
|
|
|
|
```yaml
|
|
on:
|
|
push:
|
|
branches:
|
|
- main
|
|
|
|
...
|
|
steps:
|
|
- name: Get branch names
|
|
id: branch-name
|
|
uses: tj-actions/branch-names@v5.2
|
|
|
|
- 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"
|
|
|
|
- name: Default branch name
|
|
run: |
|
|
echo "${{ steps.branch-name.outputs.default_branch }}"
|
|
# Outputs: "main" the default branch.
|
|
```
|
|
|
|
* `pull_request*`
|
|
|
|
```yaml
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- main
|
|
|
|
...
|
|
steps:
|
|
- name: Get branch names
|
|
id: branch-name
|
|
uses: tj-actions/branch-names@v5.2
|
|
|
|
- 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 branch 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".
|
|
|
|
- name: Default branch name
|
|
run: |
|
|
echo "${{ steps.branch-name.outputs.default_branch }}"
|
|
# Outputs: "main" the default branch.
|
|
```
|
|
|
|
* `tag*`
|
|
|
|
```yaml
|
|
on:
|
|
push:
|
|
tags:
|
|
- '*'
|
|
|
|
...
|
|
steps:
|
|
- name: Get branch names
|
|
id: branch-name
|
|
uses: tj-actions/branch-names@v5.2
|
|
|
|
- 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](https://github.com/actions/checkout):
|
|
|
|
```yaml
|
|
on:
|
|
pull_request:
|
|
branches:
|
|
- develop
|
|
|
|
jobs:
|
|
test:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
- name: Get branch names.
|
|
id: branch-names
|
|
uses: tj-actions/branch-names@v5.2
|
|
- uses: actions/checkout@v2
|
|
with:
|
|
ref: ${{ steps.branch-names.outputs.head_ref_branch }}
|
|
```
|
|
|
|
* Free software: [MIT license](LICENSE)
|
|
|
|
## Credits
|
|
|
|
This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter).
|
|
|
|
## Report Bugs
|
|
|
|
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.
|
|
|
|
## 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 -->
|
|
|
|
<!-- prettier-ignore-start -->
|
|
|
|
<!-- markdownlint-disable -->
|
|
|
|
<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 -->
|
|
|
|
<!-- prettier-ignore-end -->
|
|
|
|
<!-- ALL-CONTRIBUTORS-LIST:END -->
|
|
|
|
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
|