Skip to content

Github Action for finding the Pull Request (PR) associated with the current SHA.

License

Notifications You must be signed in to change notification settings

despegar/gh-find-current-pr

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

gh-find-current-pr

This action tries to figure out the current PR.

If the event is a pull_request, it's very easy to get the current PR number from the context via ${{ github.event.number }}, but unfortunately this information does not seem to be readily available for a push event. This action sends a request to GitHub to find the PR associated with the current SHA, and returns its number in the number output. number will be an empty string if there is no PR.

Additionally, title and body outputs are available as well to get the respective title and body of the PR.

By default, gh-find-current-pr will only return open PRs. You can pass in a state parameter to pick "open", "closed", or "all" PRs.

Usage

    steps:
      - uses: actions/checkout@v1
      # Find the PR associated with this push, if there is one.
      - uses: despegar/gh-find-current-pr@v1
        id: findPr
        with:
          # Can be "open", "closed", or "all".  Defaults to "open".
          state: open
      # This will echo "Your PR is 7", or be skipped if there is no current PR.
      - run: echo "Your PR is ${PR}"
        if: success() && steps.findPr.outputs.number
        env:
          PR: ${{ steps.findPr.outputs.pr }}

About

Github Action for finding the Pull Request (PR) associated with the current SHA.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%