Skip to content

RELEASING.md

Latest commit

 

History

History
17 lines (10 loc) · 904 Bytes

RELEASING.md

File metadata and controls

17 lines (10 loc) · 904 Bytes

Creating a new release:

This repository uses Github Actions to release.

  1. Go to the Create Release Pull Request workflow on GitHub Actions and click Run workflow.

  2. Fill in the inputs:

    • base-branch: main (default)
    • release-type: a SemVer bump type — major, minor, or patch (mutually exclusive with release-version)
    • release-version: a specific version to bump to, e.g. 0.15.0 (mutually exclusive with release-type)

  3. The workflow will open a Pull Request with version bumps and changelog updates.

  4. Review the pull request and merge when ready.

  5. Merging into main triggers .github/workflows/publish-release.yml, which publishes the package to npm and deploys docs to GitHub Pages.