pk changelog

Reads the conventional commits since the last version tag, infers the next version, writes the section into CHANGELOG.md, and commits with a Release-Tag trailer. No git tag is created; pk release creates it, so the release stays a two-step: generate and review, then tag and push.

Version inference

A breaking change (type!: or a BREAKING CHANGE: footer) bumps major, feat bumps minor, anything else bumps patch. --bump major|minor|patch overrides. Types map to sections via changelog.types in .pk.json; hidden types are tracked but never listed. The default table pk init writes:

feat       Added
fix        Fixed
deprecate  Deprecated
revert     Removed
security   Security
refactor   Changed
perf       Changed
docs       Documentation
chore      Maintenance
test       Maintenance
build      Maintenance
ci         Maintenance
style      Maintenance
plan       (hidden: written by pk preserve, never listed)

Edit changelog.types to rename sections, add types, or hide more. An empty table means the default table.

Usage

pk changelog --dry-run
pk changelog
pk changelog --exclude abc1234,def5678
pk changelog --undo

--dry-run prints the section to stdout and runs on a dirty tree. --exclude drops commits by short hash before bump inference. --undo unwinds an unpushed release commit, restoring CHANGELOG.md and version files.

changelog.versionFiles names JSON files whose root version field is spliced in place, formatting preserved. postVersion and preCommit hooks run with $VERSION (no v prefix).

Run it from the working branch. A protected branch is refused.

Flags

  --bump <value>
        Override the version bump: major, minor, or patch
  --dry-run
        Print the section to stdout without writing or committing
  --exclude <value>
        Comma-separated commit SHAs to drop from the section
  --undo
        Unwind the last pk changelog commit (must be unpushed)

Settings

The changelog section of .pk.json:

"changelog": {
  "hooks": {
    "postVersion": "<command>",
    "preCommit": "<command>"
  },
  "showScope": true | false,
  "types": [{ "hidden": true | false, "section": "<section>", "type": "<type>" }, ...],
  "versionFiles": [{ "path": "<path>", "type": "json" }, ...]
}

• changelog.hooks.postVersion: a shell command; default none. Runs after the version files are stamped and before CHANGELOG.md is written, with $VERSION.
• changelog.hooks.preCommit: a shell command; default none. Runs before the release commit, with $VERSION.
• changelog.showScope: true or false; default false. Includes each commit's scope in its changelog entry.
• changelog.types: a list of {"type", "section", "hidden"} rows; default the table under pk help changelog. Maps commit types to changelog sections; a hidden type is tracked and never listed; an empty list means the default table.
• changelog.versionFiles: a list of {"path", "type"} rows; default none. JSON files whose root version field is stamped in place at release.

An unknown key or a value outside these fails the whole file when it loads, with a message naming the key: pk commands exit 2, and each hook reports the message and takes no action until it is fixed. An absent key means its default. pk status reads the file back and reports the first problem.