# GitTrack

GitTrack seamlessly bridges your GitHub repositories with your Discord server, ensuring you never miss crucial project updates. Configure webhooks with ease and receive customizable notifications for a wide range of GitHub events, including commits, pull requests, issues, releases, and more — directly in your designated Discord channels.

Our bot is designed to enhance team productivity and streamline project tracking by providing real-time insights into your development workflow.

---

## 🚀 Features

- 🔗 **Link multiple GitHub repositories** to your Discord server.
- 🔧 **Per-event routing**: Send issues, PRs, releases, stars, forks, and more to specific channels.
- 🎚️ **Granular filters with `/edit-event`**: Toggle sub-events (e.g., issues opened/closed, issue/PR comments on/off).
- 🌿 **Branch tracking**: Track specific branches or all branches (`*`) per repository.
- 🧭 **Strict opt‑in**: Events only notify when explicitly enabled in `/edit-event`.
- 🧼 **Clear embeds**: Developer‑friendly, compact, informative messages.
- 🔐 **Secure webhooks**: Verified signatures for reliability.

---

## 📘 Commands Overview

### 🔧 Setup Commands

- `/setup <repository-url> [channel]`  
  Configure a repository and optionally set a default notification channel.

- `/set-default-channel <channel>`  
  Change the default channel for general GitHub notifications.

- `/link`  
  Link a branch (or `*` for all) from a repository to a specific channel. Supports autocomplete.

- `/unlink`  
  Unlink a branch from a repository, optionally from a specific channel.

- `/remove-repo`  
  Completely remove a repository and its configurations.

- `/reset confirm:true`  
  Reset all configurations for the current server.

---

### 📡 Event Routing & Filters

- `/set-event-channel <event> <channel>`  
  Route a non‑branch event (e.g., `issues`, `pull_request`, `release`, `star`, `fork`, `create`, `delete`, `milestone`, `ping`) to a specific channel.

- `/edit-event <event>`  
  Open an interactive panel to toggle sub‑events:
  - **Issues**: One config controls issues + comments (comments toggle).  
    “Assigned” also governs “unassigned”; “labeled” also governs “unlabeled”.
  - **Pull requests**: “Comments” toggle controls PR conversation comments, PR review comments, and review state “commented”.

- `/remove-event-channel <event>`  
  Remove a configured event route from a repository.

---

### 📊 Information Commands

- `/status`  
  Show the status of all tracked repositories, branches, and event routes.

- `/help`  
  Display the help message with usage instructions.

- `/ping`  
  Check if the bot is online and responsive.

---

## 🔐 Permissions

To use GitTrack setup and configuration commands, you must have the `Manage Webhooks` permission.

---

## 📋 Usage Guide

1. Use `/setup` to add a GitHub repository and receive setup instructions.
2. Add the provided webhook URL to your GitHub repository.
3. Use `/set-default-channel` to set a default notification channel.
4. Use `/link` to track branches in specific channels (autocomplete supported).  
   Use `*` as the branch name to track **all branches**.
5. Use `/set-event-channel` to route non‑branch events to channels.
6. Use `/edit-event` to fine‑tune which sub‑events notify (strict opt‑in).
7. Use `/status` to verify your configuration.
8. To stop tracking, use `/unlink`, `/remove-event-channel`, or `/remove-repo`.

GitTrack.me

Smart GitHub notifications & webhook management for Discord

Votando em GitTrack.me

Quer nos ajudar?