RELEASE NOTES

Quick notes about releasing a new version of this package. For more information, visit the cookiecutter page.

Releasing your initial packages:

git checkout develop
Make sure all changes are pushed to remote and CI is OK.
Make sure examples work in Jupyter Lab.
Make sure examples work in Jupyter Notebook. For each notebook, follow this procedure:
- Widgets > Clear widget states
- Run notebook entirely
- Setup widgets on a nice view
- Widgets > Save widget states
- Save and Close notebook
Create documentation and check everything looks fine locally.
Check linting for JS code: yarn run lint.
Change versions in _version.py, package.json and pyproject.toml. Make sure you input exactly the same numbers !

Commit version changes on both develop and master:

git add -u
git commit -m 'Bumped version to X.Y.Z'
git checkout master
git merge --ff-only develop
git checkout develop

Relase the npm packages:

npm login    # Optional, if not already done
npm publish

Release python packages:

pip install build twine   # Optional, if not already done
rm -rf dist/*

python -m build .
twine check dist/*
twine upload dist/*

Tag the release commit: git tag vX.Y.Z.
Update the version in _version.py, package.json and pyproject.toml (back to 'dev' versions).
Commit the changes in develop.
Push online git push --all && git push --tags.
Verify PyPi, NPM and readthedocs. Note that some may take a while to show the changes.