Skip to content

A GitHub bot to check that nontrivial PR commit messages refer to an issue

License

Notifications You must be signed in to change notification settings

tailscale/issuebot

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

issuebot

Note

Please file issues for this code in our main open-source repository.

issuebot listens for webhooks from GitHub for Pull Request notifications. It checks that some commit in the pull request mentions an issue, allowing us to better track development of the codebase. If no commit links to an issue, issuebot marks the PR as failing checks.

There are two special cases allowing the requirement to be skipped:

  • If a commit contains "#cleanup".

  • If the author of a commit is a known automation bot.

An author is considered a bot if:

  • Its name contains the string "[bot]"

  • Its e-mail address matches the --bot-author-regxp, and its first parenthesized subexpression (if any) is a case-insensitive match for its name once spaces are replaced by "-".

If any commit contains "skip-issuebot" (and no issue is mentioned from other commits), a stub issue will be created for the PR that you can fill out later. This also makes the CI check pass, like with "#cleanup".

Installation

go install github.com/tailscale/issuebot/cmd/issuebot@latest

About

A GitHub bot to check that nontrivial PR commit messages refer to an issue

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages