How-to guides¶

Task-oriented recipes. Each one solves a single problem and assumes you already know roughly what colophon is for.

• Run it in GitLab CI — the setup most projects want: propose on every merge, publish when the Release merge request lands.
• Run it in GitHub Actions — the same two jobs as a workflow, with the token and checkout GitHub needs.
• Hold a release back — stop a computed release being tagged, without hiding it.
• Announce a release to a chat channel — have a release say so in Discord, with the webhook named rather than written and the job ordered after the release exists.
• Publish releases to a site — append every release to a data file in another repository, so a changelog page keeps itself up to date.
• Set the version explicitly — release a specific version with a Release-As: trailer, usually to promote to 1.0.0.
• Write a release note — get real prose into the release rather than a list of commit subjects.
• Carry standing text on every release — put what the artefacts are on every release page, without repeating it in the changelog.
• Publish a release with its assets — for a repository whose releases carry binaries: the release appears with them already attached, rather than appearing empty while the build runs.
• Recover with a hand-cut tag — when colophon cannot cut the release itself: tag by hand, and create the release for that tag.

New to colophon? Start with Getting started or the first release plan tutorial.