-
Notifications
You must be signed in to change notification settings - Fork 262
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
Update release documentation #893
Conversation
@@ -235,12 +274,22 @@ In order to issue a new release, follow the following steps: | |||
make update-translations | |||
make build-translations | |||
|
|||
Once this is done, let's release!:: | |||
- If you're not completely sure of yourself at this point, you |
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.
We could make this a note?
|
||
.. note:: The above command will prompt for version number, handle | ||
:file:`CHANGELOG.rst` and :file:`setup.cfg` updates, package creation, | ||
pypi upload. It will prompt you before each step to get your consent. | ||
|
||
Finally, create a release on Github and copy the relevant changelog extract into it. | ||
Unfortunately, you need to manually convert links to Markdown... |
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 don't think we need to put that here :-) If anything, we could put the pandoc command?
If I understood correctly, PyPI supports Markdown: https://packaging.python.org/guides/making-a-pypi-friendly-readme/#creating-a-readme-file So… we can convert README and CHANGELOG to markdown once for all, and get rid of it. |
If we change to markdown I suggest that we convert all the files and do not keep rst and md. |
Co-authored-by: Baptiste Jonglez <git@bitsofnetworks.org>
No description provided.