Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xt0rted/pull-request-comment-branch
A GitHub Action to get the head ref and sha of a pull request comment
https://github.com/xt0rted/pull-request-comment-branch
comments github-actions hacktoberfest pull-requests workflows
Last synced: 3 days ago
JSON representation
A GitHub Action to get the head ref and sha of a pull request comment
- Host: GitHub
- URL: https://github.com/xt0rted/pull-request-comment-branch
- Owner: xt0rted
- License: mit
- Created: 2020-02-09T16:20:13.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2024-08-07T14:23:52.000Z (3 months ago)
- Last Synced: 2024-11-14T04:03:33.965Z (6 days ago)
- Topics: comments, github-actions, hacktoberfest, pull-requests, workflows
- Language: TypeScript
- Homepage:
- Size: 897 KB
- Stars: 87
- Watchers: 4
- Forks: 30
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Pull Request Comment Branch
[](https://github.com/xt0rted/pull-request-comment-branch/actions/workflows/ci.yml)
[](https://github.com/xt0rted/pull-request-comment-branch/actions/workflows/codeql-analysis.yml)
Get the head ref and sha of a pull request comment.
Workflows for pull request comments are triggered using the [`issue_comment`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows#issue-comment-event-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`](https://github.com/actions/checkout) and work with the pull request's code.
## Usage
```yml
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@v3
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](https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#permissions) you'll need to set `contents: read`, `issues: read` and `pull-request: read` on either the workflow or the job.
### Workflow Config
```yml
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
```yml
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](LICENSE)