Tutorials¶

Learning-oriented walkthroughs: start with nothing, finish with something that runs. If you already know what you want and need the steps, the how-to guides are shorter.

What is here¶

• Generate your first changelog: build a practice repository, generate a changelog from its history, write it to CHANGELOG.md, then read it back and fail a build on a breaking change. About fifteen minutes, no network service, nothing published.

That is the whole tutorial set today. changelog has a small surface (three entry points for generating, reading commits and parsing, four query helpers, five options) and one end-to-end walkthrough covers the generate-and-parse path through it. Reading commits is in its how-to. There is no second tutorial and no blog post covering this module; if you were sent here looking for one, it does not exist rather than being somewhere else.

Where to go after the tutorial¶

• How-to guides: one task at a time, for someone who has the basics.
• Reference: options, defaults, error values, and the exact markdown that is emitted and accepted.
• Explanation: why commits map to categories the way they do, and how commits are attributed to releases.