:octocat: Github action to retrieve branch or tag names with support for all events.
Go to file
2020-12-11 10:45:13 -05:00
.github Update test.yml 2020-12-11 09:12:15 -05:00
.gitignore Initial commit. 2020-12-11 08:15:40 -05:00
action.yml Update action.yml 2020-12-11 10:23:15 -05:00
CONTRIBUTING.md Initial commit. 2020-12-11 08:15:40 -05:00
HISTORY.md Initial commit. 2020-12-11 08:15:40 -05:00
LICENSE Initial commit. 2020-12-11 08:15:40 -05:00
README.md Update README.md 2020-12-11 10:45:13 -05:00

branch-name

Get branch information without the /ref/* prefix

...
    steps:
      - uses: actions/checkout@v2
      - name: Get branch names
        uses: tj-actions/branch-names@v1
        id: branch-names
      - name: Get Ref brach name
        run: |
          echo "${{ steps.branch-name.outputs.ref_branch }}"  #  Outputs: "main"          

      - name: Get Head Ref branch name
        if: github.event_name == 'pull_request'
        run: |
          echo "${{ steps.branch-name.outputs.head_ref_branch }}"  # Outputs: "feature/test"          

      - name: Get Base Ref branch name
        if: github.event_name == 'pull_request'
        run: |
          echo "${{ steps.branch-name.outputs.base_ref_branch }}"  # Outputs: "1/merge"          

Inputs

Input type required default
token string false ${{ github.token }}

Outputs

Output type Example Description
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 The branch that triggered the workflow run

Credits

This package was created with 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.