gong 🛎️

About

🛎️ gong is a tiny, work-in-progress, opinionated CLI for nudging/pinging reviewers on GitHub pull requests.

Installation

gong can be installed in several ways:

Using Homebrew (preferred)

brew install Djiit/homebrew-gong/gong

As a GitHub CLI extension

gh extension install Djiit/gh-gong

Using Go

go install github.com/Djiit/gong@latest

Using Docker

docker pull ghcr.io/djiit/gong

You can then run gong using:

docker run ghcr.io/djiit/gong ping --help

Using binaries

Download the appropriate binary for your platform from the GitHub releases page.

As a GitHub Action

See the gong Action.

Features

Ping reviewers on GitHub pull requests on different platforms (github comment, slack message, etc.)

Rules-Based Delay System

gong allows you to configure custom delays based on reviewer names using glob patterns. This lets you define different waiting periods before pinging different reviewers or teams.

Configuration Example

In your config file, you can specify a global delay and override it with specific rules:

# Global settings
enabled: true # Enable or disable pinging functionality globally
delay: 0 # Global delay (in seconds) before pinging reviewers

# Rules for custom delays based on reviewer name patterns
rules:
  - matchName: "@org/*"
    delay: 86400 # 24 hours delay for organization members
    enabled: true # Enable or disable this specific rule (defaults to true if not specified)
  - matchName: "external-*"
    delay: 172800 # 48 hours delay for external reviewers
    enabled: true
  - matchName: "urgent-team"
    delay: 0 # No delay for urgent team
  - matchName: "do-not-ping-*"
    delay: 0
    enabled: false # Disable pinging for reviewers matching this pattern

Rules are evaluated in order, and the first matching rule's delay is applied. If no rules match a reviewer, the global delay is used. Setting a delay to 0 means reviewers will be pinged immediately.

The enabled setting can be specified:

• At the global level to enable/disable all pinging functionality
• At the rule level to enable/disable specific rules

By default, enabled is set to true if not specified.