Revert to one release notes file #10639
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
Eric-Arellano
added
documentation
|
Cc @mtreinish. You'll want to review this commit-by-commit for useful diffs. |
Pull Request Test Coverage Report for Build 5871268688
💛 - Coveralls |
|
One or more of the the following people are requested to review this:
|
mtreinish
reviewed
Aug 16, 2023
mtreinish
approved these changes
Aug 16, 2023
mergify bot
pushed a commit
that referenced
this pull request
Aug 16, 2023
* Delete release_notes.rst * Rename file * Rewrite the prelude * Reduce nesting of headers * Oops, fix bad headers (cherry picked from commit 0388d54)
mtreinish
added a commit
to mtreinish/qiskit-core
that referenced
this pull request
Aug 17, 2023
The change to the release notes organization is only needed for the stable/0.25 branch longer term. Moving forward we'll have a different release notes strategy likely using the reno sphinx extension directly. In the short term this reverts to the previous state prior to Qiskit#10639 as while Qiskit#10639 was necessary for getting 0.25.1 released it did turn off our CI coverage testing that release notes would be built. Restoring this is important so we know from CI whether a change to the release notes works as part of the docs build. This reverts commit 0388d54.
github-merge-queue bot
pushed a commit
that referenced
this pull request
Sep 1, 2023
* Revert "Revert to one release notes file (#10639)" The change to the release notes organization is only needed for the stable/0.25 branch longer term. Moving forward we'll have a different release notes strategy likely using the reno sphinx extension directly. In the short term this reverts to the previous state prior to #10639 as while #10639 was necessary for getting 0.25.1 released it did turn off our CI coverage testing that release notes would be built. Restoring this is important so we know from CI whether a change to the release notes works as part of the docs build. This reverts commit 0388d54. * Sync release notes from 0.25.1 * Apply typo fix from #10711
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.
We have the 0.44.1/0.25.1 release coming up soon. We decided it makes most sense for those docs to live in the same
legacy_release_notes.rstfile where we already have 0.44.0/0.25.0 because the versioning is still unusual there and we want the prelude explaining what is going on.For 0.45.0 in October, we will switch to a new layout where each Qiskit version gets a dedicated HTML page. But it's premature to do that now.
So, this PR restores
legacy_release_notes.rstto berelease_notes.rstlike before. But, it is still a manually generated file to avoid all the complexity from the metapackage we don't need anymore. For the 0.44.1/0.25.1 release, we will manually generate the notes usingreno. In 0.45.0, we will go back to using the Reno Sphinx extension.An added benefit of going back to a single file is we avoid breaking any links to
release_notes.html.