chagg

chagg is a release-note workflow for Git repositories.

Instead of writing changelogs at release time, you collect small change entry files in .changes/. chagg then validates them, shows release previews, generates Markdown changelogs, and creates the next release tag.

Full documentation at chagg.dev/docs

Installation

Quick install (Linux, macOS):

curl -fsSL https://raw.githubusercontent.com/codested/chagg/main/install.sh | sh

curl -fsSL https://raw.githubusercontent.com/codested/chagg/main/install.sh | sh -s -- --version v1.2.3

curl -fsSL https://raw.githubusercontent.com/codested/chagg/main/install.sh | sh -s -- --dir ~/.local/bin

go install github.com/codested/chagg/cmd/chagg@latest

Quick start

chagg init                   # one-time setup — creates .changes/
chagg add auth/new-login     # create a change entry
chagg check                  # validate all entries
chagg log                    # preview staging changes
chagg generate > CHANGELOG.md  # generate markdown changelog
chagg release                # create the next version tag

Typical release flow

# 1) Add entries while developing
chagg add feat__oauth-login --body "Add OAuth login." --no-prompt
chagg add auth/fix__session-timeout --type fix --bump minor

# 2) Validate and preview
chagg check
chagg log

# 3) Generate and release
chagg generate > CHANGELOG.md
chagg release --push

Scripting and piping

All commands support --format json for machine-readable output. JSON includes schema_version for forward-compatible parsing.

chagg generate --format json | jq '.groups[].types[].entries[].preview'
chagg log --format json | jq '.next_tag'
chagg check --format json | jq '.summary'
chagg config --format json | jq '.git_write'
VERSION=$(chagg release --dry-run --version-only)
echo "Long description" | chagg add feat__foo --body - --bump minor

Use -q / --quiet to suppress informational messages in scripts.

Exit codes

Documentation

GitHub Action

The chagg-github-actions provides two composite actions:

• CI — validates entries on every push/PR, posts changelog preview comments
• Release — generates changelogs on version tag push, exposes changelog, version, and module_dir outputs

Community

• Contributing
• Code of Conduct
• Report an issue