RELEASE.md

Release instructions for Lumino

Using jupyter_releaser

The recommended way to make a release is to use jupyter_releaser.

Because lumino uses independent versions, the versioning must be done manually as follows:

yarn
yarn run update:versions
# Update yarn.lock
yarn
git commit -a -m "Update versions"
git push origin main

If you forget to bump the versions and need to undo:

git revert <version-bump-commit-sha>
git push origin main
push --delete origin <version-tag>

Then when triggering the Step 1: Prep Release and Step 2: Publish Release actions, you will need to set the New Version Spec to the current date <YEAR>.<MONTH>.<DAY>.

Manual Release

To create a manual release, perform the following steps:

Check for releases since the last published version to determine appropriate patch/minor/major version changes. If a dependent package moves by minor/major, then that package needs to jump minor/major as well.

git clean -dfx
yarn
yarn run update:versions
# Update the changelog with changed packages (minor or higher) and included PRs.
# Tag the release with the date, e.g. 2021.4.9
#
yarn run publish
# Push any changes to main