docs(release): improve release procedure documentation #1620
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
* correct inaccuracies from earlier versions of the release automation * describe release notes maintenance procedure * rename vx.x.x-template.tex -> vx.y.z-template.tex * remove unused function from build_dist.py * reformat python scripts in distribution/ * remove water mover performance entry from develop.tex
distribution/README.md
Outdated
| @@ -141,19 +124,23 @@ The `--approved` (short `-a`) flag can be used to approve an official release. I | |||
|
|
|||
| The `--releasemode` flag can be used to control whether binaries are built in development or release mode by editing the contents of `src/Utilities/version.f90`. If the `--releasemode` flag is provided, `IDEVELOPMODE` is set to 0. If `--releasemode` is not provided, `IDEVELOPMODE` is set to 1. | |||
There was a problem hiding this comment.
Should we clarify what these are flags to? update_version.py?
There was a problem hiding this comment.
Yes they are for update_version.py, edited to clarify that.
…ease notes section
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.
vx.x.x-template.tex->vx.y.z-template.texbuild_dist.pydistribution/develop.tex