@monup/changelog
v0.2.1
Published
Changelog generation and extraction for the second Monup workflow step.
Readme
@monup/changelog
Changelog generation and extraction for the second Monup workflow step.
Workflow Role
@monup/changelog turns commit history into changelog blocks after versioning. It also stores version markers so later steps can extract release notes for GitHub releases.
Main Exports
generateChangelog(): write a new changelog block for a version.runChangelog(): update root or per-package changelogs across a workspace.extractChangelogForVersion(): read one version block back out of a changelog.getLatestVersionFromChangelog(): detect the latest documented version.createVersionMarkers(),findVersionMarkers(), andfindVersionBlocks(): marker helpers for extraction and sync.
Example
import { defaultChangelogOptions, generateChangelog } from '@monup/changelog';
await generateChangelog(
'1.1.0',
commits,
'my-package',
defaultChangelogOptions,
);Related Packages
@monup/version: usually provides the version first.@monup/github: extracts release notes from changelog content.
