In simple English
When you build software, you need a list of what changed in each version. Writing this list by hand takes time and memory. Reading git commit messages often creates messy notes for your users. This tool lets you save small change files as you write code. It combines them into a neat release page when you are ready.
What it is
Changie is a command-line tool (a program you run in your terminal by typing text commands) that keeps track of project updates using small files stored in your repository. It avoids merge conflicts by storing each change in its own file before merging them into one release document.
What it is good for
Solo builders who want clean release notes without digging through messy commit histories or spending hours formatting markdown files by hand.
- Stores each change in its own file so teammates never block each other with merge conflicts.
- Works with any programming language or framework.
- Runs as a single small program with no complex server requirements.
- Requires you to remember to save a change file every time you write a feature or fix a bug.
- Setup involves writing configuration files and learning new terminal commands.
- Relies on a single maintainer for updates and support.
Writing change logs manually by hand or parsing messy git commit logs
GitHub Actions for automated release publishing
- mkdocs/mkdocs23k stars
Turns a folder of Markdown files into a documentation website, controlled by one settings file.
- squidfunk/mkdocs-material28k stars
Turns a folder of Markdown files into a searchable documentation website, with every formerly sponsor-only feature now included.
- halo-dev/halo40k stars
A self-hosted website and blog platform, written in Java, with a marketplace of themes and plugins.
go install github.com/miniscruff/changie@latest