branch-names/README.md
2020-12-11 10:21:30 -05:00

1.7 KiB

branch-name

Get branch information without the /ref/heads prefix

...
    steps:
      - uses: actions/checkout@v2
      - name: Get branch name
        uses: tj-actions/branch-name@v1
        id: branch-name
      - 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
ref_branch string main
head_ref_branch string feature/test
base_ref_branch string 1/merge

Credits

This package was created with Cookiecutter.

Report Bugs

Report bugs at https://github.com/tj-actions/branch-name/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.