Skip to content

Reference

Exhaustive facts: commands, flags, config keys, file schemas.

  • What colophon needs from a pipeline — the contract any CI setup has to meet: a full checkout with tags, a token that is not the job's own, publish before propose as separate jobs, and the rest.
  • Commands — every command, with its flags and defaults. plan, propose and publish are colophon's own; the rest come from the framework.
  • Configuration — config file locations and keys, environment variables, forge credentials, and the global flags.
  • Release manifest — the .colophon.yaml schema: holding a release, and shaping the notes section.
  • Commit trailers and annotations — everything colophon reads out of a commit message: the subject line and its types, breaking changes, Release-As:, Release-Note: and Updates:, and what git considers a trailer.

Go package APIs are on pkg.go.dev rather than reproduced here. For how the pieces fit together, see Components.

Run colophon <command> --help for the authoritative, always-current flag set.