Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document release process #136

Closed
fcollonval opened this issue Feb 9, 2022 · 5 comments · Fixed by jupyterlab/jupyterlab#12074
Closed

Document release process #136

fcollonval opened this issue Feb 9, 2022 · 5 comments · Fixed by jupyterlab/jupyterlab#12074

Comments

@fcollonval
Copy link
Member

At the JupyterLab Meeting Team, a discussion about 3.3 release raised the point of a need to document what are the boundaries for alpha, beta and rc stage (for major and minor versions). And also document how a release calendar is established.

Some suggestions by @jasongrout on time period during the JLab meeting:

I think a minimum 1-week RC for 3.3 is reasonable
I think a minimum 2-week RC for a major release is reasonable

@echarles
Copy link
Member

echarles commented Feb 9, 2022

Aside that release process documentation, it would be great to have a link to a published release timeline so users can plan accordingly their deployments.

@jasongrout
Copy link
Contributor

Some other thoughts from the meeting were:

  1. alpha releases have a fairly low bar - basically that JupyterLab can be installed and run. Bugs are okay, and breaking changes are okay.
  2. beta releases have typically tried to not have breaking changes in the api, though I don't think we've followed that guideline particularly faithfully.
  3. RC releases have been a signal to the extension developer community that they should start migrating to the new version to test it, and that we basically consider the software stable. We've often put off final release documentation changes or minor UX tweaks to the RC stage. During the RC phase, we also start migrating the extensions we maintain over to the new version to test it. In my experience, this work during the RC phase (and giving time for feedback from extension developers) takes a couple of weeks.

@jtpio
Copy link
Member

jtpio commented Feb 10, 2022

For reference the JupyterLab release process is documented here: https://github.com/jupyterlab/jupyterlab/blob/master/RELEASE.md

Maybe there could be a new section to explain what the expectations are in terms of the release cycles, as mentioned above.

Also this is really for JupyterLab only, as the other repos in the jupyterlab org have a lower bar and enforcing this process would add too much friction.

@jtpio
Copy link
Member

jtpio commented Feb 10, 2022

Also since JupyterLab releases are now easier to make with the Jupyter Releaser, we can more easily distribute the release management process between several people, so there is not only one person entitled to do it (to avoid bottlenecks).

@jtpio
Copy link
Member

jtpio commented Feb 17, 2022

I just opened jupyterlab/jupyterlab#12074 as a draft PR to start documenting the release process in the JupyterLab repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants