@metamask/auto-changelog

@metamask/auto-changelog

Utilities for validating and updating "Keep a Changelog" formatted changelogs.

This package has a CLI (auto-changelog), and an API.

Installation

yarn add --dev @metamask/auto-changelog

or

npm install --save-dev @metamask/auto-changelog

CLI Usage

Update

To update the 'Unreleased' section of the changelog:

npx @metamask/auto-changelog update

To update the current release section of the changelog:

npx @metamask/auto-changelog update --rc

Validate

To validate the changelog:

npx @metamask/auto-changelog validate

To validate the changelog in a release candidate environment:

npx @metamask/auto-changelog validate --rc

API Usage

Each supported command is a separate named export.

updateChangelog

This command updates the changelog.

import { promises as fs } from 'fs';
import { updateChangelog } from '@metamask/auto-changelog';

const oldChangelog = await fs.readFile('CHANGELOG.md', {
  encoding: 'utf8',
});
const updatedChangelog = updateChangelog({
  changelogContent: oldChangelog,
  currentVersion: '1.0.0',
  repoUrl: 'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
  isReleaseCandidate: false,
});
await fs.writeFile('CHANGELOG.md', updatedChangelog);

validateChangelog

This command validates the changelog

import { promises as fs } from 'fs';
import { validateChangelog } from '@metamask/auto-changelog';

const oldChangelog = await fs.readFile('CHANGELOG.md', {
  encoding: 'utf8',
});
try {
  validateChangelog({
    changelogContent: oldChangelog,
    currentVersion: '1.0.0',
    repoUrl:
      'https://github.com/ExampleUsernameOrOrganization/ExampleRepository',
    isReleaseCandidate: false,
  });
  // changelog is valid!
} catch (error) {
  // changelog is invalid
}

Contributing

Setup

• Install Node.js version 12
  • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
• Install Yarn v1
• Run yarn setup to install dependencies and run any requried post-install scripts
  • Warning: Do not use the yarn / yarn install command directly. Use yarn setup instead. The normal install command will skip required post-install scripts, leaving your development environment in an invalid state.

Testing and Linting

Run yarn test to run the tests once. To run tests on file changes, run yarn test:watch.

Run yarn lint to run the linter, or run yarn lint:fix to run the linter and fix any automatically fixable issues.

Release & Publishing

The project follows the same release process as the other libraries in the MetaMask organization:

• Create a release branch

  • For a typical release, this would be based on main
  • To update an older maintained major version, base the release branch on the major version branch (e.g. 1.x)

• Update the changelog

• Update version in package.json file (e.g. yarn version --minor --no-git-tag-version)

• Create a pull request targeting the base branch (e.g. master or 1.x)

• Code review and QA

• Once approved, the PR is squashed & merged

• The commit on the base branch is tagged

• The tag can be published as needed

Changelog

[2.3.0]

Added

• More exports to index.ts (#86)
  • Specifically, the Changelog class, createEmptyChangelog, and parseChangelog.

Fixed

• Correctly calculate the most recent git tag (#87) (#87)
  • Previously, we passed the path to the project root directory as a parameter to an invocation of git rev-list. For all repositories, this caused most tags belonging to merge commits to be excluded. For monorepos, this also caused tags belonging to commits that didn't change any files belonging to the changelog's package / workspace to be excluded.