diff options
author | 2024-06-16 13:21:15 +0200 | |
---|---|---|
committer | 2024-06-16 13:24:31 +0200 | |
commit | e28cd895257471842d99c667937a9faef17143ff (patch) | |
tree | 9169b751d040290d4953d4b6af1fd7a4d3f9bcd7 | |
parent | Add DNS record for ff-bot.pydis.wtf (diff) |
Add tooling documentation
-rw-r--r-- | docs/content/docs/tooling/_index.md | 4 | ||||
-rw-r--r-- | docs/content/docs/tooling/bots.md | 54 |
2 files changed, 58 insertions, 0 deletions
diff --git a/docs/content/docs/tooling/_index.md b/docs/content/docs/tooling/_index.md new file mode 100644 index 0000000..c811ae3 --- /dev/null +++ b/docs/content/docs/tooling/_index.md @@ -0,0 +1,4 @@ +--- +title: Tooling +description: Information about our DevOps tooling. +--- diff --git a/docs/content/docs/tooling/bots.md b/docs/content/docs/tooling/bots.md new file mode 100644 index 0000000..aaae775 --- /dev/null +++ b/docs/content/docs/tooling/bots.md @@ -0,0 +1,54 @@ +--- +title: GitHub Bots +description: | + Information on robots that keep our GitHub repositories running at full steam. +--- + +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 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.[^craig-dazey-legal-team-threats] + +Furthermore, our repositories all have dependabot configured on them. + + +## 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; +} +``` + + + +[^craig-dazey-legal-team-threats]: 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. |