krauters/GitHub Notifier by Krauters

Send Elegant Github PR Notifications

View on GitHub

Trust Signals

Scorecard Score
not yet scored
Maintenance Recency
Maintainedlast commit Apr 28, 2025
License
ISC

Pinned Snippet

workflow.ymlSHA-pinned
uses: krauters/github-notifier@ae424c1388855318aca072a5d6c4043cd06a9d6b # 1.3.2

tags can be moved; commit SHAs can't. why a SHA?

namedescriptionrequireddefault
github-tokensComma-separated list of fine grained Github tokens (one per GitHub organization) with scopes, - Administration:read (to list all repos in org) - Pull Requests:read (to get PR details for repos) - (Organzation) Members:read on all repos (to get GitHub email for Slack user matching) yes
slack-tokenPermissions to post to Slack and perform user lookups. User OAuth Token with the following user token scopes, - chat:write (to post message to Slack channels) - users:read (to get user information for GitHub user matching) - users:read.email (to get user emails for GitHub user matching) - chat:write.customize (to allow the bot to customize the name and avatar) yes
channelsComma-separated list of Slack channel IDs to post to.yes
user-mappingsComma-separated list of GitHub to Slack username mappings in the format "github:slack". These mappings are PRIORITIZED over automatic matching between GitHub and Slack users. If a mapping is defined but the Slack username doesn't exist, it will fall back to automatic matching. The automatic matching tries to match by email and username when custom mapping fails. Used specifically during Slack user lookup for @mentions and avatars in notifications. Example: "octocat:slackcat,user1:slack1" would map GitHub username "octocat" to Slack username "slackcat". no""
with-test-dataAppend some test data to the Slack post.nofalse
with-archivedInclude pull requests from archived repositories in the org.nofalse
with-publicInclude pull requests from public repositories in the org. This is useful for the case where you've not selected "All repositories" for your GitHub token and you don't want it to pull in the public ones. notrue
with-draftsInclude pull requests that are drafts in the org.nofalse
with-user-mentionsAllow Slack user mentions.notrue
repository-filterComma-separated list of repositories to scan.no
base-urlPoint to different github instance such as https://api.github.comno
namedescription
responseSlack response