Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 2.59 KB

RELEASE.md

File metadata and controls

63 lines (45 loc) · 2.59 KB
Raw

Release Process

Releases are published to npm using Release Please.

This package automates CHANGELOG generation, version bumps and npm releases by parsing the git history, looking for Conventional Commit messages.

When changes and feature PRs are merged from develop to main, release-please will open and maintain a release PR with the updated CHANGELOG and new version number. When this PR is merged, a release will be created and the package published to NPM.

  1. Merge develop into main.
  2. Release Please will create the release PR going to main.
  3. Merge the generated release PR.
  4. Package will be published to NPM.

Conventional Commit prefixes?

Commits should follow the Conventional Commit messages standard.

The following commit prefixes will result in changes in the CHANGELOG:

  • fix: which represents bug fixes, and correlates to a SemVer patch.
  • feat: which represents a new feature, and correlates to a minor version increase. (indicated by the !) and will result in a SemVer major version increase.
  • feat!:, or fix!:, refactor!:, etc., which represent a breaking change
  • build: Changes that affect the build system or external dependencies.
  • ci: Changes to our CI configuration files and scripts.
  • docs: Documentation only changes.
  • perf: A code change that improves performance.
  • refactor: A code change that neither fixes a bug nor adds a feature.
  • style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc).
  • test: Adding missing tests or correcting existing tests.
  • chore: Other

Release with a custom version number

When a commit to the main branch has Release-As: x.x.x (case insensitive) in the commit body, Release Please will open a new pull request for the specified version.

git commit --allow-empty -m "chore: release 2.0.0" -m "Release-As: 2.0.0" results in the following commit message:

chore: release 2.0.0

Release-As: 2.0.0

How can I fix release notes?

If you have merged a pull request and would like to amend the commit message used to generate the release notes for that commit, you can edit the body of the merged pull requests and add a section like:

BEGIN_COMMIT_OVERRIDE
feat: add ability to override merged commit message

fix: another message
chore: a third message
END_COMMIT_OVERRIDE

The next time Release Please runs, it will use that override section as the commit message instead of the merged commit message.