Skip to content

Package Versioning & Publishing Guide

William Yallop edited this page May 4, 2024 · 3 revisions

We use the changeset package to handle package versioning and publishing. These are the steps you should follow to version and deploy packages.

Steps

  • Create a new release branch (release/YYYY-MM-DD) from develop.
  • Run npx changeset.
  • Select the packages you wish to update the versions of.
  • Check the changes with npx changeset status --verbose.
  • If you're happy with the changes run npx changeset version.
  • If you're updating a plugin, manually bump the @lucidcms/core version and update the supported headless version on the plugin export.
  • Run npm run build.
  • Commit the changes.
  • Create a pull request for develop and master.
  • Wait for test and lint actions to pass.
  • Review the PR and merge into develop and master.
  • Create a new tag git tag -a v1.2.0 -m "v1.2.0" (this should reflect the core package version).
  • Push to the repository.

Publishing

  • Checkout the master branch.
  • Run npx changeset publish.
  • Push code.
Clone this wiki locally