Getting started¶

Install colophon and find out what it would release.

Install¶

go install gitlab.com/phpboyscout/colophon/cmd/colophon@latest

The main package lives at cmd/colophon/, so the install path ends in /cmd/colophon. Installing the module root fails, because the root has no main package.

In a pipeline, pin the tag rather than tracking @latest. colophon decides what ships, so a job installing @latest can change that decision without a commit saying so, and below 1.0 the CLI surface may still move between minor versions.

go install gitlab.com/phpboyscout/colophon/cmd/[email protected]

Release binaries are attached to each release if you would rather not build from source.

Check it runs¶

colophon version

Ask what would be released¶

plan reads a repository and prints the release its commits have earned. It writes nothing at all: no branch, no merge request, no tag. It needs no credentials, so it is safe to run against any checkout you have.

colophon plan

Point it somewhere else with -C:

colophon plan -C ~/src/some-project

Where to go next¶

• Your first release plan builds a small repository from scratch and walks through what colophon does with it.
• Run it in GitLab CI is the setup most projects actually want: propose on merge, publish on release. Run it in GitHub Actions is the same shape as a workflow.
• How the version is decided explains the rules plan applied.