Skip to content

Changelog

Terminal window
tinkerise add changelog

The changelog module checks for existing changelog config files or installed changelog dependencies (conventional-changelog-cli or standard-version).

Config detection includes:

  • .changelogrc*
  • changelog.config.js|mjs
  • .versionrc*
  • conventional-changelog-cli

changelog writes .changelogrc.json with Conventional Commits sections:

  • feat -> Features
  • fix -> Bug Fixes
  • perf -> Performance
  • refactor -> Refactoring
  • docs -> Documentation
  • chore, test, ci hidden

If commitlint is not detected, install adds a warning suggesting tinkerise add commitlint for commit message enforcement.

  • Writes .changelogrc.json with Conventional Commits preset sections
  • Adds changelog script: conventional-changelog -p conventionalcommits -i CHANGELOG.md -s
  • Adds release script: conventional-changelog -p conventionalcommits -i CHANGELOG.md -s -r 0

Expected outcome after tinkerise add changelog:

  • You can generate/update CHANGELOG.md from commit history
  • You can regenerate full release notes from the beginning of the repo

If changelog config already exists, interactive runs can show a diff and let you accept or skip generated updates.