@wtf/release-trains-changelog

A changelog of each package of a release train, with no release tool: at the top of the changelog of each package of the train, the section of a release of the commits that change its own folder, grouped by their type; and of the train, of all its commits, where it names one. The library of @wtf/semantic-release-trains-changelog, with no dependency on semantic-release.

As a library

Each function that reads git or the files takes the system it runs by, which it requires, as a CLI passes its own, adapted to the interface:

import npm from '@wtf/release-npm'
import type { System } from '@wtf/release-system/system'
import { writeChangelogs } from '@wtf/release-trains-changelog/write'

export function writeTrains(system: System, commits: { hash: string; message: string }[]) {
  return writeChangelogs({
    trains: { trains: { paths: ['packages/release-trains', 'packages/release-trains-*'] } },
    train: 'trains',
    // The packages of each train, of each package.json, as the ecosystem of npm reads them.
    ecosystems: [npm],
    version: '1.2.0',
    trainChangelog: 'CHANGELOG-trains.md',
    commits,
    system
  })
}

| Export | What it is | | -------------------------------------- | ---------------------------------------------------------------------------------------------- | | @wtf/release-trains-changelog | The types of what a changelog is given | | @wtf/release-trains-changelog/render | A commit read, a section rendered and put at the top of a changelog, and a section found again | | @wtf/release-trains-changelog/write | writeChangelogs, the changelogs of a release written, and changelogErrors, where they go |

See Changelogs.

License

MIT