GitTrack
Back to Home
Discord Bot Documentation

GitTrack Documentation

Everything you need to seamlessly integrate GitHub with Discord. Get real-time notifications, manage repositories, and keep your team synchronized with your development workflow.

What is GitTrack?

GitTrack is a powerful Discord bot that bridges your GitHub repositories with your Discord server. Get real-time notifications for pushes, pull requests, issues, releases, and workflow runs directly in your Discord channels. With advanced branch pattern matching and flexible configuration options, GitTrack keeps your team synchronized with your development workflow.

Installation

Get GitTrack up and running in your Discord server in minutes

Add GitTrack to Discord

Ready to get started? Add GitTrack to your Discord server with one click.

Click the button below to add GitTrack to your Discord server with all the required permissions automatically configured.

Add GitTrack to Discord

Quick Setup Guide

2
Add Your First Repository

Use the setup command to connect your GitHub repository:

/setup https://github.com/your-username/your-repo #notifications
2
Link Specific Branches

Target specific branches or use wildcards for pattern matching:

/link your-repo main #main-channel

Pro Tip: Use /status to check your current configuration at any time.

Commands Reference

Complete list of all available GitTrack commands and their usage

Setup Commands

Configure GitTrack for your server and manage repository connections

/setup <repository-url> [channel]

Configure a repository and optionally set a default notification channel.

Parameters

Required
repository-url(String)

The GitHub repository URL to track

Optional
channel(Channel)

Default channel for notifications

/set-default-channel <channel>

Change the default channel for general GitHub notifications. This channel will be used for not branch specific notifications like stars, issues, etc.

Parameters

Required
channel(Channel)

The Discord channel to set as default

/link

Link a branch from a repository to a specific channel. This linked channel will be used for notifications like commits, pull requests, etc. for the linked branch.

Parameters

Required
repository(String)

Repository to link

Required
branch(String)

Branch name or pattern (supports wildcards)

Required
channel(Channel)

Target Discord channel

/unlink

Unlink a branch from a repository, optionally from a specific channel.

Parameters

Required
repository(String)

Repository to unlink from

Optional
branch(String)

Specific branch to unlink

Optional
channel(Channel)

Specific channel to unlink from

/remove-repo

Completely remove a repository and all its configurations.

Parameters

Required
repository(String)

Repository to remove entirely

/reset confirm:true

Reset all configurations for the current server (requires confirmation).

Parameters

Required
confirm(Boolean)

Must be set to true to confirm reset

📊Information Commands

/status

Show the status of all tracked repositories and branches.

/help

Display the help message with usage instructions.

/ping

Check if the bot is online and responsive.

Branch Pattern Matching

GitTrack supports powerful wildcard patterns for branch tracking, making it easy to monitor groups of related branches without having to configure each one individually.

🎯 Supported Patterns

All Branches

*

Tracks all branches in the repository

Exact Branch Name

main

Tracks only the specified branch

Prefix Matching

features/*

Tracks all branches starting with "features/"

💡 Common Use Cases

features/*

All feature branches

hotfix/*

All hotfix branches

release/*

All release branches

main

Production branch only

⚠️Pattern Rules

  • • Only one wildcard (*) allowed per pattern
  • • Wildcards must appear at the end after a forward slash (/)
  • • Only alphanumeric characters, hyphens, underscores, and forward slashes allowed
  • • Multiple patterns can match the same branch

Permissions & Limits

🔐Discord Permissions

To use GitTrack setup and configuration commands, you must have theManage Webhooks permission in your Discord server.

Note: Information commands like /status, /help, and /ping can be used by any server member.

Troubleshooting

🚨 Common Issues

Bot not receiving webhooks

  • • Verify webhook URL is correct and accessible
  • • Check webhook secret matches the one from /setup
  • • Review GitHub webhook delivery logs

Notifications not appearing in Discord

  • • Check bot has Send Messages permission in target channel
  • • Verify channel is properly linked using /status
  • • Ensure branch patterns match the pushed branch
  • • Check if repository is properly configured

Branch autocomplete not working

  • • Public repos: Should work automatically
  • • Private repos: Requires manual typing or GitHub token
  • • Check repository URL is correct and accessible

💡Getting Help

If you're still experiencing issues after checking the troubleshooting guide:

• Use /status to check your configuration

• Use /help for command usage

• Join our support Discord server for assistance

• Check the GitHub webhook delivery logs for error details