Conventional commits toolkit

🌐 Translations • 📜 Code of Conduct

Monorepo with tools for analyzing git history and creating releases according to the Conventional Commits specification.

Packages

• @modulify/conventional-git — Thin wrapper over git with conventional-commit parsing and semantic tag helpers.
• @modulify/conventional-bump — Semantic-release helper that recommends the next version (major/minor/patch).
• @modulify/conventional-changelog — Generate a changelog from your git history using Nunjucks templates.
• @modulify/conventional-release — Library-first release orchestration package with a config-driven CLI.

High-level release flow

import { run } from '@modulify/conventional-release'

const result = await run()

if (!result.changed) {
  console.log('No changes since last release')
} else {
  for (const slice of result.slices) {
    if (!slice.changed) continue
    console.log(slice.id, slice.nextVersion, slice.tag)
  }
}

The @modulify/conventional-release package combines:

• version recommendation from @modulify/conventional-bump
• changelog writing from @modulify/conventional-changelog
• manifest updates
• release commit and tag creation

It also ships the conventional-release binary, so a consumer project can use:

{
  "scripts": {
    "release": "conventional-release",
    "release:dry": "conventional-release --dry"
  }
}

See the package README for the full API and CLI reference: @modulify/conventional-release

Low-level composition

If you want to build your own release flow, the lower-level packages can still be used directly:

import { Client } from '@modulify/conventional-git'
import { ReleaseAdvisor } from '@modulify/conventional-bump'
import { createWrite } from '@modulify/conventional-changelog'
import semver from 'semver'

const git = new Client()
const advisor = new ReleaseAdvisor({ git })

const currentVersion = await git.version() ?? '0.0.0'
const recommendation = await advisor.advise({
  preMajor: semver.lt(currentVersion, '1.0.0')
})

if (recommendation) {
  const nextVersion = semver.inc(currentVersion, recommendation.type)
  const write = createWrite({ git, file: 'CHANGELOG.md' })

  await write(nextVersion)
  console.log(`Next release: ${nextVersion}`)
}

Why this exists

The project did not start as an abstract experiment. It grew out of a practical need to work with deeply nested workspace trees, including repositories with two or three levels of nesting, where most release tools on the market still assume a flat or near-flat monorepo layout.

Repository development

Local setup:

make .yarnrc.yml
yarn install

Useful commands:

make test
make test-coverage
make build
make typecheck
make eslint

Release preview for this repository:

yarn release:dry