Reference¶

Exact, checkable facts about what changelog does: every option and its default, every error value, the markdown it emits, the markdown it accepts, and the point at which each of those runs out.

What is in this section¶

• Generation options — the three GenerateOption values, their defaults, how they combine, and what an invalid value does.
• Commit classification — which commit type becomes which category, which types are dropped, and how breaking changes are detected.
• Generated output format — the exact markdown GenerateFromRepo emits, heading by heading, and the order of everything in it.
• Accepted changelog formats — what Parse accepts, what it maps to, and the shapes it silently reads as something else.
• Errors and return values — every sentinel error, every wrapped error, and the cases where a nil is returned with no error at all.

Where the Go API reference lives¶

Signatures, types and doc comments are on pkg.go.dev, generated from the source, and are not repeated here. This section documents behaviour — defaults, ordering, failure modes, and the shape of the text going in and out — which a signature cannot tell you.

Configuration, flags and environment variables¶

There are none. changelog is a library: it reads no configuration file, no environment variable and no flags, and it ships no binary. Everything that varies is passed as an argument or a GenerateOption by the calling program. If you are looking for a changelog command to run, see What changelog does not do.