Get the branch name from a pull request (PR)

Forked from andrevalentin/get-branch-name-by-pr.

A Github Action that retrieves the branch name from a PR and sets it in the output for other actions to use.It can either accept a specific PR ID/number, or try to take from the current context if none is provided.

📝 Read the blog post Cypress GitHub Actions Slash Command

Usage

Example of providing a PR ID to fetch & subsequently use the branch name

- name: Get branch name based on PR ID
  uses: bahmutov/get-branch-name-by-pr@v1
  id: pr_data
  with:
    repo-token: ${{ secrets.GITHUB_TOKEN }}
    pr-id: 123

- name: Checkout code
  uses: actions/checkout@v2
  with:
    ref: ${{ steps.pr_data.outputs.branch }}

Example where the action just takes the PR ID from context

- name: Get branch name based on PR
  uses: bahmutov/get-branch-name-by-pr@v1
  id: pr_data
  with:
    repo-token: ${{ secrets.GITHUB_TOKEN }}

- name: Checkout code
  uses: actions/checkout@v2
  with:
    ref: ${{ steps.pr_data.outputs.branch }}

License

The scripts and documentation in this project are released under the MIT License