Congratsbot

Congratsbot is a webhook for announcing code merges to Discord and celebrating contributors.

Example:

🎊 Merged! Eva Decker: Release (#232)
Featuring contributions by Luke Lennon! 🌟

Prerequisites

Create a new Discord webhook and add the URL to your repository secrets as DISCORD_WEBHOOK_CONGRATS.

Usage

name: Congratsbot

on:
  push:
    branches: [main]

jobs:
  congrats:
    uses: namesakefyi/congratsbot/.github/workflows/congratsbot.yml@main
    secrets:
      DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK_CONGRATS }}
    with:
      # Optional: Don't post to Discord if a commit matches these regex patterns
      exclude: '["^chore\\(deps\\)", "^chore:", "\\[skip\\]"]'  

The exclude parameter accepts an array of regex patterns. Messages matching any pattern will be skipped. Patterns are case-insensitive by default. For example:

• "^chore\\(deps\\)" - matches messages starting with "chore(deps)"
• "^chore:" - matches messages starting with "chore:"
• "\\[skip\\]" - matches messages containing "[skip]"

Credits

The implementation of this bot was forked from Astro Automation Tools.

The congratsbot avatar is from Emoji Kitchen.