Jupyterhub

shell
tbump --no-tag ${NEXT_VERSION}.dev


1. Following the release to PyPI, an automated PR should arrive to
[conda-forge/jupyterhub-feedstock][] with instructions.

[pypi]: https://pypi.org/project/jupyterhub/
[conda-forge]: https://anaconda.org/conda-forge/jupyterhub
[jupyterhub/jupyterhub]: https://github.com/jupyterhub/jupyterhub
[conda-forge/jupyterhub-feedstock]: https://github.com/conda-forge/jupyterhub-feedstock
[github-activity]: https://github.com/executablebooks/github-activity
[ci system]: https://github.com/jupyterhub/jupyterhub/actions/workflows/release.yml


How to make a release

`jupyterhub-systemdspawner` is a package available on [PyPI] and on
[conda-forge].

These are the instructions on how to make a release.

Pre-requisites

- Push rights to this GitHub repository

Steps to make a release

1. Create a PR updating `CHANGELOG.md` with [github-activity] and continue when
its merged.

Advice on this procedure can be found in [this team compass
issue](https://github.com/jupyterhub/team-compass/issues/563).

2. Checkout main and make sure it is up to date.

shell
git checkout main
git fetch origin main
git reset --hard origin/main


3. Update the version, make commits, and push a git tag with `tbump`.

shell
pip install tbump


`tbump` will ask for confirmation before doing anything.

shell
Example versions to set: 1.0.0, 1.0.0b1
VERSION=
tbump ${VERSION}


Following this, the [CI system] will build and publish a release.

4. Reset the version back to dev, e.g. `1.0.1.dev` after releasing `1.0.0`.

shell
Example version to set: 1.0.1.dev
NEXT_VERSION=
tbump --no-tag ${NEXT_VERSION}.dev


5. Following the release to PyPI, an automated PR should arrive within 24 hours
to [conda-forge/jupyterhub-systemdspawner-feedstock] with instructions on
releasing to conda-forge. You are welcome to volunteer doing this, but aren't
required as part of making this release to PyPI.

[github-activity]: https://github.com/executablebooks/github-activity
[pypi]: https://pypi.org/project/jupyterhub-systemdspawner/
[ci system]: https://github.com/jupyterhub/jupyterhub-systemdspawner/actions/workflows/release.yaml
[conda-forge]: https://anaconda.org/conda-forge/jupyterhub-systemdspawner
[conda-forge/jupyterhub-systemdspawner-feedstock]: https://github.com/conda-forge/jupyterhub-systemdspawner-feedstock


How to make a release

`jupyterhub-kubespawner` is a package available on [PyPI][] and [conda-forge][].
These are instructions on how to make a release.

Pre-requisites

- Push rights to [github.com/jupyterhub/kubespawner][]
- Push rights to [conda-forge/jupyterhub-kubespawner-feedstock][]

Steps to make a release

1. Create a PR updating `docs/source/changelog.md` with [github-activity][] and
continue only when its merged.

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


1. Following the release to PyPI, an automated PR should arrive to
[conda-forge/jupyterhub-kubespawner-feedstock][] with instructions.

[github-activity]: https://github.com/executablebooks/github-activity
[github.com/jupyterhub/kubespawner]: https://github.com/jupyterhub/kubespawner
[pypi]: https://pypi.org/project/jupyterhub-kubespawner/
[conda-forge]: https://anaconda.org/conda-forge/jupyterhub-kubespawner
[conda-forge/jupyterhub-kubespawner-feedstock]: https://github.com/conda-forge/jupyterhub-kubespawner-feedstock
[ci system]: https://github.com/jupyterhub/kubespawner/actions/workflows/publish.yaml

Fixes

- Exchanging ldap3 constants in if/else ([175](https://github.com/jupyterhub/ldapauthenticator/pull/175)) ([1kastner](https://github.com/1kastner))

Fixes

- Pin ldap3 version to lower than 2.8 ([172](https://github.com/jupyterhub/ldapauthenticator/pull/172)) ([1kastner](https://github.com/1kastner))

This release requires Python >=3.6 and JupyterHub >=1.5.1.

New features added

- allow for req_keepvars_extra to be configured [295](https://github.com/jupyterhub/batchspawner/pull/295) ([mark-tomich](https://github.com/mark-tomich), [minrk](https://github.com/minrk))

Bugs fixed

- Remove `which jupyterhub-singleuser` command from `SlurmSpawner.batch_script` [265](https://github.com/jupyterhub/batchspawner/pull/265) ([t20100](https://github.com/t20100), [consideRatio](https://github.com/consideRatio))

Maintenance and upkeep improvements

- TST: don't assume test user is OS user [301](https://github.com/jupyterhub/batchspawner/pull/301) ([minrk](https://github.com/minrk))
- Add python 3.12 for tests [299](https://github.com/jupyterhub/batchspawner/pull/299) ([Ph0tonic](https://github.com/Ph0tonic), [consideRatio](https://github.com/consideRatio))
- maint: req py36+ and jh 1.5.1+, fix tests, add RELEASE.md, add pre-commit hooks, add dependabot [273](https://github.com/jupyterhub/batchspawner/pull/273) ([consideRatio](https://github.com/consideRatio), [mbmilligan](https://github.com/mbmilligan), [ryanlovett](https://github.com/ryanlovett), [yuvipanda](https://github.com/yuvipanda), [mahendrapaipuri](https://github.com/mahendrapaipuri))
- Upgrade singleuser.py to JupyterHub 4 [267](https://github.com/jupyterhub/batchspawner/pull/267) ([mahendrapaipuri](https://github.com/mahendrapaipuri), [minrk](https://github.com/minrk), [consideRatio](https://github.com/consideRatio))
- Remove reading/setting HubAuth SSL attributes in singeuser [259](https://github.com/jupyterhub/batchspawner/pull/259) ([cmd-ntrf](https://github.com/cmd-ntrf), [consideRatio](https://github.com/consideRatio))
- Fix Slurm test used regular expression [256](https://github.com/jupyterhub/batchspawner/pull/256) ([t20100](https://github.com/t20100), [consideRatio](https://github.com/consideRatio))
- Quell async warning, and POST with body for jupyterhub 3.0 [247](https://github.com/jupyterhub/batchspawner/pull/247) ([ryanlovett](https://github.com/ryanlovett), [mbmilligan](https://github.com/mbmilligan), [rcthomas](https://github.com/rcthomas), [minrk](https://github.com/minrk), [jbeal-work](https://github.com/jbeal-work), [mawigh](https://github.com/mawigh), [cmd-ntrf](https://github.com/cmd-ntrf), [jaescartin1](https://github.com/jaescartin1))
- Improve submit_batch_script logging [219](https://github.com/jupyterhub/batchspawner/pull/219) ([cmd-ntrf](https://github.com/cmd-ntrf), [consideRatio](https://github.com/consideRatio), [mbmilligan](https://github.com/mbmilligan))

Documentation improvements

- Add temporary info about a temporary bug with JupyterHub 3+ [290](https://github.com/jupyterhub/batchspawner/pull/290) ([krokicki](https://github.com/krokicki), [consideRatio](https://github.com/consideRatio))

Continuous integration improvements

- Modernize test matrix [252](https://github.com/jupyterhub/batchspawner/pull/252) ([mbmilligan](https://github.com/mbmilligan))

Contributors to this release

The following people contributed discussions, new ideas, code and documentation contributions, and review.
See [our definition of contributors](https://github-activity.readthedocs.io/en/latest/#how-does-this-tool-define-contributions-in-the-reports).

([GitHub contributors page for this release](https://github.com/jupyterhub/batchspawner/graphs/contributors?from=2022-10-05&to=2024-03-19&type=c))

basnijholt ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Abasnijholt+updated%3A2022-10-05..2024-03-19&type=Issues)) | cmd-ntrf ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Acmd-ntrf+updated%3A2022-10-05..2024-03-19&type=Issues)) | consideRatio ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3AconsideRatio+updated%3A2022-10-05..2024-03-19&type=Issues)) | jaescartin1 ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Ajaescartin1+updated%3A2022-10-05..2024-03-19&type=Issues)) | jbeal-work ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Ajbeal-work+updated%3A2022-10-05..2024-03-19&type=Issues)) | krokicki ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Akrokicki+updated%3A2022-10-05..2024-03-19&type=Issues)) | mahendrapaipuri ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Amahendrapaipuri+updated%3A2022-10-05..2024-03-19&type=Issues)) | mark-tomich ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Amark-tomich+updated%3A2022-10-05..2024-03-19&type=Issues)) | mawigh ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Amawigh+updated%3A2022-10-05..2024-03-19&type=Issues)) | mbmilligan ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Ambmilligan+updated%3A2022-10-05..2024-03-19&type=Issues)) | minrk ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Aminrk+updated%3A2022-10-05..2024-03-19&type=Issues)) | opoplawski ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Aopoplawski+updated%3A2022-10-05..2024-03-19&type=Issues)) | Ph0tonic ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3APh0tonic+updated%3A2022-10-05..2024-03-19&type=Issues)) | rcthomas ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Arcthomas+updated%3A2022-10-05..2024-03-19&type=Issues)) | ryanlovett ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Aryanlovett+updated%3A2022-10-05..2024-03-19&type=Issues)) | t20100 ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3At20100+updated%3A2022-10-05..2024-03-19&type=Issues)) | yuvipanda ([activity](https://github.com/search?q=repo%3Ajupyterhub%2Fbatchspawner+involves%3Ayuvipanda+updated%3A2022-10-05..2024-03-19&type=Issues))