Add some more notes to the release workflow #1121
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
tech3371
reviewed
Nov 6, 2024
Comment on lines
+48
to
+50
| #. If there have been release-specific commits, In GitHub, create a pull request that merges the version branch into | ||
| ``dev``. Proceed with the nominal review & merge process described in steps (10) and (11) in the :ref:`git & GitHub | ||
| Workflow <git-and-github-workflow>` section. |
There was a problem hiding this comment.
I am not good with release. I tried to release last month to fix a bug and I think I had to merge PR before I create a new release. I tried to see if I can find notes but I couldn't. Is that what you do also? If so, should this step be moved one above.
There was a problem hiding this comment.
Good point, I think you are right about the ordering. That is how I do it for sds_data_manager, which usually requires some release-specific commits to update version numbers.
I updated the docs to reflect the correct order, and also added some more notes.
tech3371
approved these changes
Nov 7, 2024
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.
This PR updates the Release Workflow docs to add some notes on the expected cadences of the releases, as well as make some minor updates based on how we have been making releases.