Github/Bots

Notes

Notes on Github bots and automation.

Markdown Cleanup

The goal: linkify and clean up markdown files in Github repositories that are being turned into an mkdocs site.

Markdown Cleanup Bot

This is the "interactive", user-requested bot alternative. This makes more sense when you may have lots of types of pull requests, and you want markdown cleanup to be REQUESTED.

This is a bot that can be installed into a repository, and can then be mentioned in pull requests in that repository, and will respond with a commit that cleans up the markdown.

Markdown Cleanup Github Bot

(This is still unclear, how you give a bot account access to a repo, or even how you give an OAuth app access to a repo)

Markdown Webhook Script

This alternative is a scripted, conditional script that is triggered by a pull request event webhook. This can be used to only apply markdown cleanup on pull requests from a particular user, members of a particular team, containing keywords, modifying particular Markdown files, etc.