Release plan for 4.0.0

[consideRatio]

Let's plan for the 4.0.0 release!

Current and proposed breaking changes:

• Drop support for Python 3.6 #350
• Rename @jupyterlab/server-proxy to @jupyterhub/jupyter-server-proxy #368
• Drop support for Python 3.7 #387
• maint, breaking: drop support for jupyterlab 2 #394

Additional non-blocking nice to get done:

• docs: convert .rst to MyST based markdown files #393
• Add manager for tracking and terminating running server proxies #395
• Support Windows:
  • Help Add support for Windows platform simpervisor#26 get merged
  • Help https://github.com/jupyterhub/simpervisor get released
  • Setup tests to run in windows at least once in this repo

[yuvipanda]

yes, 100% on keeping jupyter_server 1 support still. I don't have an exact link but somewhere we had to set jupyter_server<2 to preserve compatibility with something else...

[manics]

The last release of JupyterLab 2 was in August 2021. What are the reasons to commit to supporting it for 4.*?

There's discussion in #383 about adding new UI components. Without getting into the question of whether we should add new UI components or not, if we do keep JupyterLab 2 it increases the development and testing work required. JupyterLab 4 is also in beta so potentially we'd be supporting three versions soon.

[consideRatio]

The last release of JupyterLab 2 was in August 2021. What are the reasons to commit to supporting it for 4.*?

With jupyterlab 2 being that old, maybe ~no reason.

👍 For dropping it

[manics]

Could we try and get windows support in too? jupyterhub/simpervisor#26

[manics]

pyproject.toml claims we already do!

jupyter-server-proxy/pyproject.toml

Line 31 in bc49c6e

"Operating System :: Microsoft :: Windows",

We should remove it if we can't get Windows working.

[consideRatio]

I added #395 to the list of breaking changes as it proposes a change of a API route. I'd love to get that PR part of the release as well no matter what though because it seems like a great feature for this project.

[consideRatio]

I figure we shouldn't let #395 block a release, but instead go for faster releases.

@bollwyvl and @manics with #394 in I'll open a changelog PR if you think it makes sense.

[consideRatio]

• I also opened maint: update package description to not claim windows support #398 that makes sense to merge before a release

[consideRatio]

I did tbump 4.0.0 just a bit too quick, and forgot to refreeze the labextensions yarn.lock file, but cancelled the automation in time to avoid publishing to PyPI/NPM.

I also had to fix the version pattern accepted in tbump config.

This is the result, and we have 4.0.0 published.

[consideRatio]

Almost, there was an error for the PyPI release.

Run pypa/gh-action-pypi-publish@v1.8.5
  with:
    password: ***
    user: __token__
    repository_url: https://upload.pypi.org/legacy/
    packages_dir: dist
    verify_metadata: true
    skip_existing: false
    verbose: false
    print_hash: false
  env:
    pythonLocation: /opt/hostedtoolcache/Python/3.11.3/x64
    PKG_CONFIG_PATH: /opt/hostedtoolcache/Python/3.11.3/x64/lib/pkgconfig
    Python_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.3/x64
    Python[2](https://github.com/jupyterhub/jupyter-server-proxy/actions/runs/4755664077/jobs/8450165563#step:5:2)_ROOT_DIR: /opt/hostedtoolcache/Python/[3](https://github.com/jupyterhub/jupyter-server-proxy/actions/runs/4755664077/jobs/8450165563#step:5:3).11.3/x6[4](https://github.com/jupyterhub/jupyter-server-proxy/actions/runs/4755664077/jobs/8450165563#step:5:4)
    Python3_ROOT_DIR: /opt/hostedtoolcache/Python/3.11.3/x64
    LD_LIBRARY_PATH: /opt/hostedtoolcache/Python/3.11.3/x64/lib
/usr/bin/docker run --name c04427[5](https://github.com/jupyterhub/jupyter-server-proxy/actions/runs/4755664077/jobs/8450165563#step:5:5)499f2fdc2844d2b7397686a5049abf_1d4268 --label 6c0442 --workdir /github/workspace --rm -e "pythonLocation" -e "PKG_CONFIG_PATH" -e "Python_ROOT_DIR" -e "Python2_ROOT_DIR" -e "Python3_ROOT_DIR" -e "LD_LIBRARY_PATH" -e "INPUT_PASSWORD" -e "INPUT_USER" -e "INPUT_REPOSITORY-URL" -e "INPUT_REPOSITORY_URL" -e "INPUT_PACKAGES-DIR" -e "INPUT_PACKAGES_DIR" -e "INPUT_VERIFY-METADATA" -e "INPUT_VERIFY_METADATA" -e "INPUT_SKIP-EXISTING" -e "INPUT_SKIP_EXISTING" -e "INPUT_VERBOSE" -e "INPUT_PRINT-HASH" -e "INPUT_PRINT_HASH" -e "HOME" -e "GITHUB_JOB" -e "GITHUB_REF" -e "GITHUB_SHA" -e "GITHUB_REPOSITORY" -e "GITHUB_REPOSITORY_OWNER" -e "GITHUB_REPOSITORY_OWNER_ID" -e "GITHUB_RUN_ID" -e "GITHUB_RUN_NUMBER" -e "GITHUB_RETENTION_DAYS" -e "GITHUB_RUN_ATTEMPT" -e "GITHUB_REPOSITORY_ID" -e "GITHUB_ACTOR_ID" -e "GITHUB_ACTOR" -e "GITHUB_TRIGGERING_ACTOR" -e "GITHUB_WORKFLOW" -e "GITHUB_HEAD_REF" -e "GITHUB_BASE_REF" -e "GITHUB_EVENT_NAME" -e "GITHUB_SERVER_URL" -e "GITHUB_API_URL" -e "GITHUB_GRAPHQL_URL" -e "GITHUB_REF_NAME" -e "GITHUB_REF_PROTECTED" -e "GITHUB_REF_TYPE" -e "GITHUB_WORKFLOW_REF" -e "GITHUB_WORKFLOW_SHA" -e "GITHUB_WORKSPACE" -e "GITHUB_ACTION" -e "GITHUB_EVENT_PATH" -e "GITHUB_ACTION_REPOSITORY" -e "GITHUB_ACTION_REF" -e "GITHUB_PATH" -e "GITHUB_ENV" -e "GITHUB_STEP_SUMMARY" -e "GITHUB_STATE" -e "GITHUB_OUTPUT" -e "RUNNER_OS" -e "RUNNER_ARCH" -e "RUNNER_NAME" -e "RUNNER_TOOL_CACHE" -e "RUNNER_TEMP" -e "RUNNER_WORKSPACE" -e "ACTIONS_RUNTIME_URL" -e "ACTIONS_RUNTIME_TOKEN" -e "ACTIONS_CACHE_URL" -e GITHUB_ACTIONS=true -e CI=true -v "/var/run/docker.sock":"/var/run/docker.sock" -v "/home/runner/work/_temp/_github_home":"/github/home" -v "/home/runner/work/_temp/_github_workflow":"/github/workflow" -v "/home/runner/work/_temp/_runner_file_commands":"/github/file_commands" -v "/home/runner/work/jupyter-server-proxy/jupyter-server-proxy":"/github/workspace" 6c0442:75499f2fdc2844d2b7397686a5049abf  "__token__" "***" "" "" "" "" "false" ""
Notice: Using a user-provided API token for authentication against https://upload.pypi.org/legacy/
Checking dist/jupyter_server_proxy-4.0.0-py3-none-any.whl: PASSED
Checking dist/SHA25[6](https://github.com/jupyterhub/jupyter-server-proxy/actions/runs/4755664077/jobs/8450165563#step:5:6)SUMS: ERROR    InvalidDistribution: Unknown distribution format: 'SHA256SUMS'

The error message of relevance was: ERROR InvalidDistribution: Unknown distribution format: 'SHA256SUMS' and stems from exposing the PyPI publish action for a file named SHA256SUMS we have created ourselves.

[consideRatio]

I downloaded the built wheel and source distribution from https://github.com/jupyterhub/jupyter-server-proxy/actions/runs/4755664077, extracted, and concluded they had the correct checksum, then used twine to upload them manually.

I'll fix the checksum issue next.