-
Notifications
You must be signed in to change notification settings - Fork 674
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
Release guide #131
Release guide #131
Conversation
6. Confirm that the new version of Jupyter Book [is posted to pypi](https://pypi.org/project/jupyter-book/) | ||
7. Bump the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py) to | ||
the next minor (or major) release and append `dev` to the end. | ||
9. Celebrate! You've just released a new version of Jupyter Book! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is also the issue of updating the docs, no?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
docs??? who cares about docs?! ;-)
RELEASES.md
Outdated
[following the twine release instructions](https://twine.readthedocs.io/en/latest/#using-twine) | ||
6. Confirm that the new version of Jupyter Book [is posted to pypi](https://pypi.org/project/jupyter-book/) | ||
7. Bump the [Jupyter Book version number](https://github.com/jupyter/jupyter-book/blob/master/jupyter_book/__init__.py) to | ||
the next minor (or major) release and append `dev` to the end. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the convention is dev0. See: https://www.python.org/dev/peps/pep-0440/#public-version-identifiers
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Wild. I had been totally ignoring that convention. Thanks for sharing !!
I think this is great, thank you !! ✨ 🚀 In terms of the actual process: There's a decent amount we can automate away using e.g., versioneer and release drafter, but I can open issues about integrating those later 😸 For the file placement: Yes, it'd be great to have these in dev or governance docs eventually. #121 is very much on my mind -- once that is integrated, I think we can re-organize to put this information nearby. For now, though, having these guidelines easy-to-find seems like the best default ! |
Cool! Gonna merge this since comments are addressed and we've got passing tests+approval :-) |
Adds a short release guide, which I followed to make a quick release of jupyter-book (because the current
pip
version didn't link files properly so install wouldn't work).@emdupre does this seem like a reasonable place for a release guide? If we ever build up the dev docs it can probably be moved there...