Jupyterhub

- report better errors when sudospawner fails; change unhelpful `ValueError: substring not found`
message when parsing output fails to a more helpful message and log the unparsed data
- treat failures to signal the process as the process being missing, and log the failure, instead of raising errors

- return ip, port from Spawner.start (future-compatibility, as setting ip, port directly is deprecated in JupyterHub 0.7)
- better handling of errors in the mediator
- allow overriding single-user spawn via sudospawner-singleuser script

- initial release containing `TorqueSpawner` and `SlurmSpawner`


How to make a release

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

Pre-requisites

- Push rights to [jupyterhub/jupyterhub][]
- Push rights to [conda-forge/jupyterhub-feedstock][]

Steps to make a release

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

shell
pip install github-activity

github-activity --heading-level=3 jupyterhub/jupyterhub


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}

tbump ${VERSION}


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

- Fixes for compatibility with jupyterhub-0.4
- Relay subprocess output to Hub, to reduce silent errors
- `sudospawner` executable **must** be in the same dir as `jupyterhub-singleuser`

First release


How to make a release

`dockerspawner` is a package available on [PyPI] and [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 `docs/source/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/dockerspawner-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/dockerspawner/
[conda-forge]: https://anaconda.org/conda-forge/dockerspawner
[conda-forge/dockerspawner-feedstock]: https://github.com/conda-forge/dockerspawner-feedstock
[ci system]: https://github.com/jupyterhub/dockerspawner/actions/workflows/release.yaml


How to make a release

`batchspawner` 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/batchspawner-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/batchspawner/
[ci system]: https://github.com/jupyterhub/batchspawner/actions/workflows/release.yaml
[conda-forge]: https://anaconda.org/conda-forge/batchspawner
[conda-forge/batchspawner-feedstock]: https://github.com/conda-forge/batchspawner-feedstock


Changelog

unreleased changes

Added (user)

Added (developer)

Changed

Fixed