GitHub

repo-release-tools

repo-release-tools has three main surfaces:

  • Generated CLI reference for local release automation, Git helpers, config inspection, and the bundled rrt skill install command
  • GitHub Action for CI policy checks that mirror the local workflow
  • Generated topic docs: Semantic branches and rrt git for the branch naming model and Git workflow guidance

If you need command syntax, start with the generated CLI reference first. It is the canonical home for the current rrt command surface.

Start here

  • Generated CLI reference — generated reference for branches, bumps, Git workflow helpers, config checks, and skill installation
  • GitHub Action — CI checks for branch names, commit subjects, changelog policy, and optional doctor/dirty-tree gates
  • pre-commit / lefthook — local hook setup for incremental or squash-based changelog workflows
  • Skills — bundled uvx and installed-CLI agent skills

Then follow the workflow

  • rrt branch — generated branch naming model and allowed branch types
  • rrt git — generated Git helpers and workflow shortcuts
  • rrt tree — generated guide for rrt tree output modes, ignore behavior, and traversal controls
  • MCP Server — MCP install and connect guide

Command reference by group

The CLI is split into per-group reference pages (auto-generated from the live argparse tree) and prose topic pages for individual commands.

Auto-generated group reference pages

Group Commands Page
Version & Release bump, changelog, ci-version, release, workspace, tag version-release
Repository Health doctor, artifacts, config, env, eol, toc, tree, docs, drift, folder repo-health
Git Workflow branch, git git-workflow
CI & Automation action ci-automation
Setup & Tooling install, init, skill, agents, hooks setup-tooling

The rrt CLI index page has the global help and links to all groups.

Prose topic pages

Doc Content
branch Branch naming model and allowed types
bump Stub — see version-release
ci_version Stub — see version-release
config_cmd Stub — see repo-health
doctor Repository automation health checks
drift Agent-facing surface drift detection
env_cmd Stub — see repo-health
eol_check Runtime end-of-life checks
folder Folder structure supervision
git_cmd Git workflow helpers
hooks pre-commit / lefthook hook setup
init Stub — see setup-tooling
install Agent surface installation
skill Bundled agent skills
toc Markdown TOC generation
tree Directory tree rendering

Changelog workflow

repo-release-tools supports two changelog styles:

  • incremental (default) — maintain changelog state during development
  • squash — skip per-commit changelog enforcement and generate or correct changelog entries when changes are squashed together

If you are unsure where to start:

  1. Read commands/rrt-cli.md to confirm the available CLI commands and changelog_workflow config
  2. Read commands/hooks.md for the matching local hook setup
  3. Read action.md to see how changelog-strategy: auto follows that workflow in CI

Visual identity

Terminal banners

Dark theme Light theme
banner-dark banner-light

Rendered by rrt at launch. ASCII art generated by banner.py using Pillow.

Badge families

Adaptive SVG badges switch automatically between dark and light variants based on the viewer’s system preference (prefers-color-scheme). Five variants per badge family are available:

These badges are intentionally complete for the current source-of-truth icon registry in src/repo_release_tools/tools/platform.py. If an icon appears missing, update the registry and badge mappings together so the docs, source-code anchors, and icon list stay in lockstep across platform, registry, and language labels.

Platform

Label Color Dark Light Reto Dark Reto Light
GitHub
GitLab
Bitbucket
Azure DevOps
Codeberg
Gitea
Helm
Kubernetes
GitHub Actions
Bash
Java
Generic

Registry

Label Color Dark Light Reto Dark Reto Light
PyPI
npm
NuGet
Cargo
RubyGems
Packagist
Docker

Language

Label Color Dark Light Reto Dark Reto Light
Python
JavaScript
TypeScript
Go
Rust
.NET
Ruby
PHP
C++
Swift
Kotlin
Dart
Perl
Scala
Haskell

Badge icons sourced from Simple Icons (CC0-1.0) and Google Material Icons (Apache-2.0). See src/repo_release_tools/tools/platform.py for full attribution. Bash and Java appear in both the Platform and Language label sets; they are listed under Platform only.

↑ Docs index · CLI reference · Changelog · GitHub