Update release documentation #893
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
almet
requested changes
Oct 26, 2021
almet
reviewed
Oct 26, 2021
| @@ -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 | |||
almet
reviewed
Oct 26, 2021
|
|
||
| .. 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.
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. |
TomRoussel
pushed a commit
to TomRoussel/ihatemoney
that referenced
this pull request
Mar 2, 2024
Co-authored-by: Baptiste Jonglez <git@bitsofnetworks.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.