Use Jupyter Releaser - Githubissues

jupyter-server / enterprise_gateway

A lightweight, multi-tenant, scalable and secure gateway that enables Jupyter Notebooks to share resources across distributed clusters such as Apache Spark, Kubernetes and others.

https://jupyter-enterprise-gateway.readthedocs.io/en/latest/

Other

615 stars 221 forks source link

Use Jupyter Releaser #1188

Open blink1073 opened 1 year ago

blink1073 commented 1 year ago

@kevin-bates mentioned that we'd like to use Jupyter Releaser in this repo.

I think we need the following:

Have a script that handles version bumps with a single argument for the new version. It should probably be a python script that combines what update_version_to_release and update_version_to_development do and "does the right thing" based on whether the version has dev in it.
Add an after-build-python releaser hook with ["make kernelspecs helm-chart docker-images"]
Add a step in the publish workflow that runs publish-images with shared credentials so it isn't run in check-release. We can add a bot docker account for these credentials.

kevin-bates commented 1 year ago

Thank you @blink1073. I'd like to spend some time on this early next week. Can you recommend a good "model project" from which I can copy the basics? I don't think jupyter_server is ideal due to its dependency on npm and wondering if something like jupyter_client or nbclient might be better.

I would also like to generate the first release of remote_provisioners next week and would love to have releaser support there, but wondering if releaser is something that can be used outside the organization?

blink1073 commented 1 year ago

nbconvert is a reasonable example.

jupyter_server has a good example of using hooks.

jupyterlab has an example of using a custom version-cmd

kevin-bates commented 1 year ago

I'm not sure when we can get to this but will definitely refer to these when we do - thanks!

blink1073 commented 1 year ago

The version bump script could be done independently - and used from release.sh.

rahul26goyal commented 1 year ago

Hi @blink1073 I can work with you on this with guidance. Let me go over the examples which you have shared this weekend and get back to you early next week?

blink1073 commented 1 year ago

Sounds good, thanks @rahul26goyal!

kevin-bates commented 1 year ago

Hi @rahul26goyal - when you get to this, it would be good to reduce the release preparation and post-release commits to one each, instead of two, as it is now. I suspect this is a side-effect of using tbump within release.sh and it may not be possible to reduce down to a single commit for each phase, but I think it would be good to understand if that's possible. Thanks.