Get Current Pull Request
ActionsTags
(2)
Github Action for checking if the current commit belongs to a pull request and returning the full PR object if that is the case
Inside a running github action you can't always get the information whether you are currently in a PR or not. If for example the trigger event is pull_request you have that information but not when your trigger event is push.
This action enables you to get the PR no matter which event type triggered the workflow.
steps:
- uses: 8BitJonny/[email protected]
id: PR
- run: echo "Your PR number is ${{ steps.PR.outputs.number }} and its JSON is ${{ steps.PR.outputs.pr }}"See action.yml for more details.
steps:
- uses: 8BitJonny/[email protected]
id: PR
with:
# Authetication token to access GitHub APIs. (Can be omitted by default.)
github-token: ${{ github.token }}
# For which commit SHA the action should lookup a PR for (By default current commit)
sha: ${{ github.event.pull_request.head.sha }}
# Only return if PR is still open. (By default it returns PRs in any state.)
filterOutClosed: true
# Only return if PR is not in draft state. (By default it returns PRs in any state.)
filterOutDraft: trueSee action.yml for more details.
steps:
- uses: 8BitJonny/[email protected]
id: PR
- run: echo "PR ${prNumber} ${prTitle} at ${prUrl} is ${prJSON}"
if: steps.PR.outputs.pr_found == 'true'
env:
# JSON object with the full PR object
# toJSON(fromJSON(...pr)) parses it into memory and then format is with pretty-print.
prJSON: ${{ toJSON(fromJSON(steps.PR.outputs.pr)) }}
# Direct access to common PR properties
prNumber: ${{ steps.PR.outputs.number }}
prUrl: ${{ steps.PR.outputs.pr_url }}
prTitle: ${{ steps.PR.outputs.pr_title }}
prBody: ${{ steps.PR.outputs.pr_body }}
prCreatedAt: ${{ steps.PR.outputs.pr_created_at }}
prMergedAt: ${{ steps.PR.outputs.pr_merged_at }}
prClosedAt: ${{ steps.PR.outputs.pr_closed_at }}
prLabel: ${{ steps.PR.outputs.pr_labels }}Useful when the information you're looking for is not exported as a direct output of the action. Simply parse the pr output as JSON and navigate the object.
See GitHub Documentation for details how the object looks like.
steps:
- uses: 8BitJonny/[email protected]
id: PR
- name: "Pull Request ${{ steps.PR.outputs.number }}"
if: steps.PR.outputs.pr_found == 'true'
run: |
echo "from ${{ fromJSON(steps.PR.outputs.pr).head.ref }}"
echo "to ${{ fromJSON(steps.PR.outputs.pr).base.ref }}"Currently, if you try to find a PR that hasn't been merged yet AND which has been closed, then this app will completely fail in finding that PR. This workflow can only find open PRs, draft PRs and closed+merged PRs.
See #165 for the progress on this issue as this might come in a later version.
Contributions are always welcome!
Get Current Pull Request is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.
Tags
(2)Get Current Pull Request is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.