Skip to main content

GitHub Bot

GitPOAP provides a GitHub Bot that will notify contributors when they have earned a GitPOAP for their contributions after their Pull Request is merged. This notification is in the form of a comment on the PR that earned the GitPOAP, and looks like:

For the bot to start notifying contributors, project owners will need to opt-in.

Installing on your Project

If you'd like gitpoap-bot to start notifying your contributors when they've received a GitPOAP for their contribution, first navigate to the GitHub App page for the gitpoap-bot. On the top right you should see a configure button:

Click on this link and then click on the organization you'd like to add the bot to:

You will be taken to an installation configuration page for your GitHub Organization. From here, you should scroll down to the "Repository Access" section, click on the "Only select repositories" option, select any repos that have GitPOAPs associated with them, and then hit "Save" underneath. As an example, we at GitPOAP have created a GitPOAP for the repository for this documentation:

And that's it! Now gitpoap-bot will start notifying users when their merged PRs have earned them new GitPOAPs.

Tagging contributors

Gitpoap-bot also has the capability to issue GitPOAPs to contributors by tagging them in a comment. When both @gitpoap-bot and one or more contributors' handles are tagged within a comment on a PR or Issue, a new GitPOAP claim will be issued to these users if they don't have one already.

For example, to issue a new GitPOAP to a GitHub user via a PR or Issue, add a comment with @gitpoap-bot tagged like so:

Note: @gitpoap-bot can appear anywhere in the comment, & the names of contributors do NOT have to directly follow @gitpoap-bot.