repo-release-tools

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

Commands reference

The docs/commands/ directory mirrors src/repo_release_tools/commands/ plus the workflow-owned hook entrypoint in src/repo_release_tools/workflow/hooks.py. The source tree now groups shared domains under config/, docs/, eol/, version/, workflow/, and integrations/ instead of leaving those modules flat at src/repo_release_tools/. Each generated page documents one command or source-owned topic module.

Doc Module Status
branch commands/branch.py full
bump commands/bump.py stub
ci_version commands/ci_version.py stub
config_cmd commands/config_cmd.py stub
doctor commands/doctor.py full
env_cmd commands/env_cmd.py stub
eol_check commands/eol_check.py full
folder commands/folder.py stub
git_cmd commands/git_cmd.py full
hooks hooks.py full
init commands/init.py stub
rrt-cli cli.py + all commands auto-generated
skill commands/skill.py full
tree commands/tree.py full

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

↑ Docs index · CLI reference · Changelog · GitHub