Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
message-square

GitHub Action

Pull Request Comment Branch

v1.1.0

Pull Request Comment Branch

message-square

Pull Request Comment Branch

Gets the head ref and sha of a pull request comment

Installation

Copy and paste the following snippet into your .yml file.

              

- name: Pull Request Comment Branch

uses: xt0rted/[email protected]

Learn more about this action in xt0rted/pull-request-comment-branch

Choose a version

Pull Request Comment Branch

Dependabot Status

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 mater) 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@v1
        id: comment-branch
        with:
          repo_token: ${{ secrets.GITHUB_TOKEN }}

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

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

Options

Required

Name Allowed values Description
repo_token GITHUB_TOKEN or a custom value The token used to call the GitHub api.

Outputs

Name Decription
ref The name of the pull request branch the comment belongs to.
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