changie

Changie is an automated changelog tool designed to assist with release preparation. It is language and framework agnostic, distributed as a single Go binary.

Key capabilities include:

• File-based changelog management: Keeps commit history and release notes decoupled.
• Continuous tracking: Allows you to track changes during development while the context is fresh.
• High customizability: Provides extensive configuration options to match specific project styles and requirements.

To begin using Changie, you can refer to the following resources:

• Official Website: https://changie.dev/ for full user documentation.
• User Guide: The guide is the recommended starting point for new users.
• GitHub Action: For automated workflows, use the Changie GitHub Action.
• Examples: Check the ./examples directory in the repository for various configuration files and video demonstrations.

Use the miniscruff/changie-action to integrate Changie into your GitHub workflows. You can pass arguments to the changie CLI via the args input.

- name: Batch a new minor version
  uses: miniscruff/changie-action@VERSION # view action repo for latest version
  with:
    version: latest # use the latest changie version
    args: batch minor

When preparing a release, use the batch command to group all unreleased changes into a single version. You can specify the versioning strategy in three ways:

1. Semver bump values: Provide <major|minor|patch> to indicate the type of version bump.
2. Explicit version: Provide a specific <version> string.
3. Automatic bumps: Provide auto if you have configured kinds in your .changie.yaml to support automatic version detection.

# changie supports semver bump values
changie batch <major|minor|patch>

# using an explicit version
changie batch <version>

# or using auto if you have kinds configured for auto bumps
changie batch auto

Use go install to download Changie from the main branch.

go install github.com/miniscruff/changie@latest

To get started quickly, use the default configuration generated by running the initialization command. This setup is designed to work out-of-the-box with standard settings.

changie init

You can run Changie using Docker images hosted on GitHub Packages. When running in Docker, use an interactive terminal (-it) to complete prompts, and consider passing your current user and group ID to ensure created files have the correct permissions.

# Basic run (replace 'latest' with a specific version or command)
docker run \
    --mount type=bind,source=$PWD,target=/src \
    -w /src \
    ghcr.io/miniscruff/changie \
    latest

# Recommended run for interactive prompts and correct file permissions
docker run \
    --mount type=bind,source=$PWD,target=/src \
    -w /src \
    -it \
    --user $(id -u ${USER}):$(id -g ${USER}) \
    ghcr.io/miniscruff/changie \
    new

You can install Changie manually by downloading binaries or packages from the GitHub releases page:

• Binaries: Download the executable and add it to your system PATH.
• Debian/RPM: Download the .deb or .rpm file and install using dpkg -i or rpm -i respectively.

After you have successfully batched a new version, use the merge command to incorporate those changes into the parent CHANGELOG.md file.

changie merge

On Windows, you can use either Scoop or Winget.

# Using Scoop
scoop bucket add changie https://github.com/miniscruff/changie
scoop install changie

# Using Winget
winget install miniscruff.changie