diff --git a/docs/development.md b/docs/development.md index 2938fdb..9b88544 100644 --- a/docs/development.md +++ b/docs/development.md @@ -22,7 +22,7 @@ well. Releases are done manually, for now: -1. Ensure that the build is up to date with `npm run build`. -1. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them. +1. Ensure that the build is up to date with `npm run build`. It's also good to ensure you have the correct dependencies installed by running `npm install` before you build. +1. Bump the [package.json](/package.json#L3) and [package-lock.json](/package-lock.json#L3) version numbers and commit them. I like to do this with `npm version {major,minor,patch} --no-git-tag-version`. This will bump the version numbers but let you manually commit and tag, yourself. 1. Update documentation (including updated version numbers). -1. Tag main with the new version number and create a GitHub release. +1. Tag main with the new version number and create a GitHub release. Make sure you also force-create and force-push tags for minor and patch updates. For example, when creating v5.1.0 (a minor bump), you want to create (or update) `v5`, `v5.1`, and `v5.1.0`.