Release documentation and notes #624
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
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
touma-I
approved these changes
Sep 25, 2024
RELEASE.md
Outdated
| @@ -3,7 +3,7 @@ | |||
| ## Overview | |||
| Release are created from the main repository branch using the version | |||
| numbers, including an intermediate version suffix, | |||
| defined in `.make.versions`. | |||
| defined in `.make.versions` | |||
| The following points are important: | |||
|
|
|||
| 1. In general, common a version number is used for all published pypi wheels and docker images. | |||
There was a problem hiding this comment.
do you mean: a common (it is written common a)
RELEASE.md
Outdated
| @@ -3,7 +3,7 @@ | |||
| ## Overview | |||
| Release are created from the main repository branch using the version | |||
There was a problem hiding this comment.
Should that read "Release is" or "Releases are" ?
| @@ -20,29 +20,35 @@ allows intermediate publishing from the main branch using version X.Y.Z.dev\<N\> | |||
| ## Cutting the release | |||
| Creating the release involves | |||
|
|
|||
| 1. Edit the `release-notes.md` to list major/minor changes | |||
| 1. Creating a release branch and tag and updating the main branch versions. | |||
| 1. Creating a github release from the release branch and tag. | |||
| 1. Building and publishing pypi library wheels and docker registry image. | |||
There was a problem hiding this comment.
Is this missing the step for creating a new dev branch that increments the release number ?
Also should we use Create a ..., Build and publish... similar to first bullet.
There was a problem hiding this comment.
i think that is covered in 2 ...and updating the main branch versions.
Signed-off-by: David Wood <[email protected]>
Signed-off-by: David Wood <[email protected]>
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.
Why are these changes needed?
Updates to release documentation
Add release notes for 0.2.1 release
Related issue number (if any).