Rewrite release guide as summarised recipes#15878
Open
jakelishman wants to merge 1 commit intoQiskit:mainfrom
Open
Rewrite release guide as summarised recipes#15878jakelishman wants to merge 1 commit intoQiskit:mainfrom
jakelishman wants to merge 1 commit intoQiskit:mainfrom
Conversation
The previous release guide was very detailed, but had proven fairly hard to follow in practice (from experience in the 2.3 and 2.4 releases). This replaces it with "recipes" for each kind of release, which should primarily render as summary steps, where each can expand to include a complete set of command-line commands to run that perform the actions described in the text. I also reduced some of the prose, and cut out some metadata steps that are now part of the modern pull-request review checklist, to avoid overloading on information.
jakelishman
added
the
Changelog: None
Collaborator
|
One or more of the following people are relevant to this code:
|
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
The previous release guide was very detailed, but had proven fairly hard to follow in practice (from experience in the 2.3 and 2.4 releases). This replaces it with "recipes" for each kind of release, which should primarily render as summary steps, where each can expand to include a complete set of command-line commands to run that perform the actions described in the text.
I also reduced some of the prose, and cut out some metadata steps that are now part of the modern pull-request review checklist, to avoid overloading on information.
Summary
Details and comments
I would read the rendered version of it rather than the in-code version - I had to do a couple of awkward tricks to get the
<details>stuff to render acceptably because GitHub does much more limited Markdown processing within those drop-downs.