Pull Request Badge lets you programatically insert badges in your pull request descriptions and then link them to anything. Like this one 👇
After installation, Pull Request Badge will receive a webhook event whenever a Pull Request is opened or edited. Based on the configuration file in your repository, badges that match criteria will be inserted at the beginning of the Pull Request description.
I initially created Pull Request Badge to deal with JIRA links, but it can easily present any kind of information through the simple and flexible API. For example: how about adding a preview badge with a link to a preview instance? Or indicate if the Pull Request is rather large? Check out the $payload attribute for more details. Your creativity is the limit.
Hello there! I'm Stefan 👋 I care a lot about efficiency and that's the reason I built a browser extension that allows you to navigate through code on GitHub much more efficiently. OctoLinker is trusted by over 25,000 developers. Read the story behind Pull Request Badge on my blog.
This is just the beginning! I have plenty other ideas on how to make your developer experience much better. Sign up to be the first to hear about other tools I'm working on.
.github/pr-badge.ymlfile in your repository with the following content.
- label: "JIRA"message: "$issuePrefix"color: "#0052CC"url: "https://jira.company.com/browse/$issuePrefix"when: "$issuePrefix"
Text on the left side of the badge.
Text on the right side of the badge.
If added, the badge will be wrapped with this URL.
The color for the badge. The default value is
The URL of the image.
$additions > 200
- label: "Preview"message: "PR $prNumber"color: "blue"url: "https://pr-$prNumber.company.com"
Raw webhook payload object from GitHub. Check out the webhook payload example for further information.
The number of this Pull Request.
The name of the branch where your changes are implemented.
The branch name or Pull Request title issue prefix extracted when following the Naming Convention.
Indicates whether this Pull Request is a draft.
The number of additions made in this Pull Request
The number of deletions made in this Pull Request
Total number of commits
Total number of changed files
Name of the repository owner
Name of the repository
The repository slug eg. Codertocat/Hello-World
Pull Request Badge uses the following naming convention to extract the
$issuePrefix. Please make sure your branch name or Pull Request title contains an uppercase issuePrefix.
ABC-123] Better accessibility
Pull Request Badge requires the following GitHub permissions:
This file contains the configuration for Pull Request Badge. We cannot read or write any source code!
All GitHub Apps require the Metadata permission. The metadata permission provides access to a collection of read-only endpoints with metadata for various resources. These endpoints do not leak sensitive private repository information.
We use the Pull Requests permission to listen for new Pull Requests required to update the pull request descritpon with badges.
No, not yet. The source code is exclusively available to people who sponsor me on GitHub, but after reaching a certain number of sponsors, the software fully open-source and available to anyone.
Yes, we do. Check out our plans for details on private GitHub repositories.
Become a sponsorware "customer" and you will get access to the source code which then allows you to run the app yourself.
»With a large distributed engineering team, it can be hard to enforce rules about including links to tickets within
Pull Requests;having it automated was the perfect solution and it’s super slick.«
»As engineers we use GitHub heavily every day. We just as often need to interface with other systems or resources such as Atlassian Jira or deployment previews. Pull Request Badge helps us bridging the gaps and linking to anything external becomes a breeze.«
»With the Pull Request Badge App developers have everything they need to move forward and this helps us to make our communication much more effective.«