kareemmax / pull-request-comment-branch

A GitHub Action to get the head ref and sha of a pull request comment

Pull Request Comment Branch

Get the head ref and sha of a pull request comment.

Workflows for pull request comments are triggered using the issue_comment event which runs for both issues and pull requests. This action lets you filter your workflow to comments only on pull requests. It also gets the head ref and sha for the pull request branch which can be used later in the workflow.

The pull request head ref and sha are important because issue_comment workflows run against the repository's default branch (usually main or master) and not the pull request's branch. With this action you'll be able to pass the ref to actions/checkout and work with the pull request's code.

Usage

on:
  issue_comment:
    types: [created]

jobs:
  pr-comment:
    runs-on: ubuntu-latest
    steps:
      - uses: xt0rted/pull-request-comment-branch@v2
        id: comment-branch

      - uses: actions/checkout@v2
        if: success()
        with:
          ref: ${{ steps.comment-branch.outputs.head_ref }}

      - run: git rev-parse --abbrev-ref HEAD
      - run: git rev-parse --verify HEAD

Token Permissions

If your repository is using token permissions you'll need to set contents: read, issues: read and pull-request: read on either the workflow or the job.

Workflow Config

on: issue_comment
permissions:
  contents: read
  issues: read
  pull-requests: read
jobs:
  pr-comment:
    runs-on: ubuntu-latest
    steps:
      - uses: xt0rted/pull-request-comment-branch@v2

Job Config

on: issue_comment
jobs:
  pr-comment:
    runs-on: ubuntu-latest
    permissions:
      contents: read
      issues: read
      pull-requests: read
    steps:
      - uses: xt0rted/pull-request-comment-branch@v2

Options

Required

Name	Allowed values	Description
repo_token	GITHUB_TOKEN (default) or PAT	GITHUB_TOKEN token or a repo scoped PAT.

Outputs

Name	Decription
base_ref	The name of the branch the pull request will merge into.
base_sha	The head sha of the branch the pull request will merge into.
head_ref	The name of the pull request branch the comment belongs to.
head_sha	The head sha of the pull request branch the comment belongs to.

License

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