diff options
author | 2024-08-09 15:33:12 +0100 | |
---|---|---|
committer | 2024-08-09 15:42:03 +0100 | |
commit | d5237039cb38bba13fc89db041f5574c92394599 (patch) | |
tree | d993d4e35f8682a8f208bec4be4abae81a49e6e4 /docs/docs/tooling/github-bots.md | |
parent | Add mkdocs packages (diff) |
Add mkdocs-material documentation
Diffstat (limited to 'docs/docs/tooling/github-bots.md')
-rw-r--r-- | docs/docs/tooling/github-bots.md | 53 |
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/docs/tooling/github-bots.md b/docs/docs/tooling/github-bots.md new file mode 100644 index 0000000..aefee13 --- /dev/null +++ b/docs/docs/tooling/github-bots.md @@ -0,0 +1,53 @@ +--- +description: We use GitHub bots to enhance the Developer and DevOps team experience. +--- +# GitHub Bots + +Our GitHub repositories are supported by two custom bots: + +- Our **Fast Forward Bot**, which ensures that commits merged into main are + either merged manually on the command line or via a fast-forward, ensuring + that cryptographic signatures of commits remain intact. Information on the bot + can be found [in the ff-bot.yml + configuration](https://github.com/python-discord/infra/blob/main/.github/ff-bot.yml). + Merges over the GitHub UI are discouraged for this reason. You can use it by + running `/merge` on a pull request. Note that attempting to use it without + permission to do so will be reported. +- Our **Craig Dazey Emulator Bot**, which ensures team morale stays high + at all times by thanking team members for submitted pull requests.[^1] + +Furthermore, our repositories all have dependabot configured on them. + +[^1]: Craig Dazey Emulator Bot stands in no affiliation, direct or indirect, + with Craig Dazey. Craig Dazey Emulator Bot. Craig Dazey Emulator Bot is not + endorsed by Craig Dazey. Craig Dazey Emulator Bot is an independent project + of Craig Dazey. No association is made between Craig Dazey Emulator Bot and + Craig Dazey. + + +## Dealing with notifications + +This section collects some of our team members' ways of dealing with the +notifications that originate from our bots. + +### Sieve (RFC 5228) script + +If your mail server supports the [Sieve mail filtering +language](https://datatracker.ietf.org/doc/html/rfc5228.html), which it should, +you can adapt the following script to customize the amount of notifications you +receive: + +``` sieve +require ["envelope", "fileinto", "imap4flags"]; + +if allof (header :is "X-GitHub-Sender" ["coveralls", "github-actions[bot]", "netlify[bot]"], + address :is "from" "[email protected]") { + setflag "\\seen"; + fileinto "Trash"; + stop; +} +``` + +If you also want to filter out notifications from renovate, which we use for +dependency updates, you can add `renovate[bot]` to the `X-GitHub-Sender` list +above. |