This is the projects first release on GitHub even though there was some releases
to PyPI. A lot of work was put in by pushing directly to the master branch. For
a full list of changes only the commit history will do justice.
Merged PRs
- Canvas ID Authentication [7](https://github.com/jupyterhub/ltiauthenticator/pull/7) ([samhinshaw](https://github.com/samhinshaw))
- Canvas Implementation Instructions [6](https://github.com/jupyterhub/ltiauthenticator/pull/6) ([samhinshaw](https://github.com/samhinshaw))
- Add support for forwarded protocol in headers (reverse_proxy) [5](https://github.com/jupyterhub/ltiauthenticator/pull/5) ([brospars](https://github.com/brospars))
How to make a release
`jupyterhub-ltiauthenticator` is a package available on [PyPI][]. These are
instructions on how to make a release.
Pre-requisites
- Push rights to [github.com/jupyterhub/ltiauthenticator][]
Steps to make a release
1. Create a PR updating `docs/source/changelog.md` with [github-activity][] and
continue only when its merged. Some guidance is available in a
[jupyterhub/team-compass issue][].
1. Checkout main and make sure it is up to date.
shell
git checkout main
git fetch origin main
git reset --hard origin/main
1. Update the version, make commits, and push a git tag with `tbump`.
shell
pip install tbump
tbump --dry-run ${VERSION}
run
tbump ${VERSION}
Following this, the [CI system][] will build and publish a release.
1. Reset the version back to dev, e.g. `2.0.1.dev0` after releasing `2.0.0`.
shell
tbump --no-tag ${NEXT_VERSION}.dev0
[jupyterhub/team-compass issue]: https://github.com/jupyterhub/team-compass/issues/563
[github-activity]: https://github.com/executablebooks/github-activity
[github.com/jupyterhub/ltiauthenticator]: https://github.com/jupyterhub/ltiauthenticator
[pypi]: https://pypi.org/project/jupyterhub-ltiauthenticator/
[ci system]: https://github.com/jupyterhub/ltiauthenticator/actions/workflows/publish.yaml