aboutsummaryrefslogtreecommitdiffstats
path: root/docs/tooling/bots.rst
blob: e38f83cdb2035e9b8037032887c5744463602d29 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
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. [1]_

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:

.. code:: 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.

.. [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.