Mitten

Mitten is a Python script designed to monitor GitHub repositories for new commits and send notifications to a specified Discord channel. The script leverages the GitHub API to fetch commit information and Discord Webhooks to post notifications.

Features

• Fetches commits from specified GitHub repositories.
• Sends commit notifications to Discord with detailed commit information.
• Ability to mention specified roles in commit notifications.
• Supports selecting specific branches from each repository.
• Logs commit information locally to avoid duplicate notifications.
• Fetches commits pushed since the last runtime of the script, ensuring that commits pushed during downtime are still fetched in the next run.
• Configurable through environment variables.

Requirements

• Python 3.7+
• requests library
• python-dotenv library

Configuration

Create a '.env' file in the same directory as the script with the following variables:

• REPOS: A comma-separated list of repositories to monitor. You can also optionally specify a branch for each repo by adding ':branch_name' (e.g., 'owner/repo1,owner/repo1:dev_branch,owner/repo2').
• DISCORD_WEBHOOK_URL: The Discord webhook URL where notifications will be sent.
• GITHUB_TOKEN: (Optional but highly recommended) Your GitHub API token to avoid rate limiting. Learn more about creating a personal access token here.
• CHECK_INTERVAL: The interval (in seconds) at which the script checks for new commits. Make sure this value is less than the number of repos to monitor.
• DISCORD_EMBED_COLOR: (Optional) The color of the commit embeds sent to Discord. The color must be provided in hexadecimal format using the prefix '0x' (e.g., '0xffffff').
• ROLES_TO_MENTION: (Optional) The role IDs (NOT role name, but the corresponding 19 digit role ID) to mention in Discord when a new commit is detected. Separate each role ID with a comma. You can also ping @everyone by simply setting this to '@everyone'.
• WEBHOOKS_ON_REPO_INIT: Choose whether to send a message to Discord whenever a new repository is initialized.
• PREFER_AUTHOR_IN_TITLE: Preference for title style in commit messages. If set to True, the commit author's username and avatar will be used in the title of the embed. If set to False, the repo name and the repo owner's avatar will be used.
• TEST_WEBHOOK_CONNECTION: Send a test message to Discord when the script is started.

Installation

1. Clone the repository:

   git clone https://github.com/joobert/mitten.git
   cd mitten

2. Install dependencies:

   pip install -r requirements.txt

3. Create a .env file with the following content:

   REPOS=owner/repo1,owner/repo1:dev_branch,owner/repo2,owner/repo3
   DISCORD_WEBHOOK_URL=your_webhook_url
   GITHUB_TOKEN=your_github_token
   CHECK_INTERVAL=60
   DISCORD_EMBED_COLOR=
   ROLES_TO_MENTION=
   WEBHOOKS_ON_REPO_INIT=True
   PREFER_AUTHOR_IN_TITLE=False
   TEST_WEBHOOK_CONNECTION=False

4. Run the script:

   python mitten.py

(Optional) Running with Docker

Ensure you have both Docker and Docker Compose installed on your machine.

1. Clone the repository:

   git clone https://github.com/joobert/mitten.git
   cd mitten

2. Create a .env file with the following content:

   REPOS=owner/repo1,owner/repo1:dev_branch,owner/repo2,owner/repo3
   DISCORD_WEBHOOK_URL=your_webhook_url
   GITHUB_TOKEN=your_github_token
   CHECK_INTERVAL=60
   DISCORD_EMBED_COLOR=
   ROLES_TO_MENTION=
   WEBHOOKS_ON_REPO_INIT=True
   PREFER_AUTHOR_IN_TITLE=False
   TEST_WEBHOOK_CONNECTION=False

3. Create empty commit_log.json and mitten_logs.txt files:

   touch commit_log.json mitten_logs.txt

4. Start the service with Docker Compose:

   docker-compose up -d

Important Notes

• Initial Run: On the first run (and for each subsequent repository added down the line), Mitten will initialize each repository by fetching its entire commit history to avoid spamming notifications and fetch commits pushed during the script's downtime on the next run. This process can be API heavy and time-consuming for large repositories, but only needs to be done once per repository.

• GitHub Token: It is highly recommended to set a GitHub API token to avoid API rate limiting issues. Without the token, you will be limited to 60 requests per hour, which might not be sufficient for monitoring multiple repositories, nor sufficient for the initial run of a large repository. Setting the token increases this limit significantly (5000 requests per hour) ensuring you won't run into issues.

• Logging: Mitten creates and logs commit information locally in a file named 'commit_log.json' to ensure that no duplicate notifications are sent. The script also saves its runtime logs to a file named 'mitten_logs.txt'. Both of these should be kept in the same directory as the script.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request or open an Issue.

License

MIT