commit-email-bot logo Commit Email Bot

commit-email-bot sends emails when changes are pushed to a git repository on GitHub. It sends one email per commit, with the diff in the body.

Getting Started

Install the commit-emails GitHub app and give it access to the repositories you want notifications for.

In your repo, commit a file called .github/commit-emails.toml that specifies the recipients:

# commit-emails.xyz config
to = "alice@example.com,bob@example.net"

You can optionally specify "email.format" as "html" (the default) or "text".

Emails from commit-email-bot come from notify@commit-emails.xyz, with the name of the commit author. Every email from commit-email-bot contains the string jD27HVpTX3tELRBjcpGsK6io7 followed by the name of the repo. You can use this to easily filter commit notifications in Gmail.

Privacy Policy

This app attempts to store the minimal data required for it to work.

On a public repository commit-email-bot only uses and stores your repository's public contents.

If you give commit-email-bot access to a private repo, it will have access to your repository contents and will send diffs that include your code to the configured email addresses. Please do not use it with very sensitive data.


GitHub source