Remove Qiskit Terra 0.25 from release_notes.rst #11436
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
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 7280975929
💛 - Coveralls |
jakelishman
reviewed
Dec 20, 2023
docs/release_notes.rst
Outdated
Comment on lines
9
to
11
| These release notes get converted into Markdown files via the infrastructure at https://github.com/Qiskit/documentation, which then gets deployed to https://docs.quantum.ibm.com/api/qiskit/release-notes. Changes to these release notes will update those release notes the next time the API docs are generated. | ||
|
|
||
| To change release notes prior to Qiskit 0.45, update the Qiskit/documentation repository directly. |
There was a problem hiding this comment.
This appears to be a developer-facing comment - perhaps a better place would be the docs contributing guide? Alternatively, it could be a rST comment:
This page contains [...]
..
These release notes [...]I'm just thinking on the off-chance that this text starts getting used again at some point in the future as part of the docs build - we wouldn't this to accidentally start getting published.
Eric-Arellano
added
stable backport potential
jakelishman
approved these changes
Dec 21, 2023
mergify bot
pushed a commit
that referenced
this pull request
Dec 21, 2023
* Remove Qiskit Terra 0.25 from release_notes.rst * Review feedback: use a comment (cherry picked from commit 22a372f)
github-merge-queue bot
pushed a commit
to Qiskit/documentation
that referenced
this pull request
Dec 29, 2023
This PR changes how we write the Qiskit `release-notes.html` to correctly split the notes by version, updating the previous files if we find any change. If we already have a file for the version we updated, the script adds the new entries without overwriting the file and sorts the entries by patch. If the patch we modified was already in the version file, it substitutes its section for the new one. Qiskit v0.45 has been regenerated using the new script to split correctly versions 0.45 and 0.25 to remove the last one from the file. Historical release notes files (< 0.45) will no longer be updated in the regeneration. For more information see: Qiskit/qiskit#11436 Command used: `npm run gen-api -- -p qiskit -v 0.45.0 -a https://github.com/Qiskit/qiskit/suites/17881600359/artifacts/1026798160` Closes #359 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
This PR changes how we write the Qiskit `release-notes.html` to correctly split the notes by version, updating the previous files if we find any change. If we already have a file for the version we updated, the script adds the new entries without overwriting the file and sorts the entries by patch. If the patch we modified was already in the version file, it substitutes its section for the new one. Qiskit v0.45 has been regenerated using the new script to split correctly versions 0.45 and 0.25 to remove the last one from the file. Historical release notes files (< 0.45) will no longer be updated in the regeneration. For more information see: Qiskit/qiskit#11436 Command used: `npm run gen-api -- -p qiskit -v 0.45.0 -a https://github.com/Qiskit/qiskit/suites/17881600359/artifacts/1026798160` Closes Qiskit#359 --------- Co-authored-by: Eric Arellano <14852634+Eric-Arellano@users.noreply.github.com>
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.
@arnaucasau is improving the infrastructure in Qiskit/documentation in Qiskit/documentation#537 so that changing release notes for prior release versions will properly update those release note files. Right now, the repository only updates with the current version.
However, we're running into issues due to Qiskit Terra 0.25 being included in
release_notes.html. Really, Terra 0.25 refers to Qiskit 0.44. It messes up our script, which splits out the single filerelease_notes.htmlinto distinct pages like0.44.md,0.45.md, etc. Our script naively thinks that Qiskit Terra 0.25 should be Qiskit 0.25, i.e. the file0.25.md.We could add special-casing to the infrastructure in Qiskit/documentation to handle this edge case. But instead of adding that complexity, @ElePT, @arnaucasau and I were discussing that it seems unlikely we'll be changing release notes for Terra 0.25 at this point. If we do need to change them, we can always directly modify the notes in Qiskit/documentation.
This PR will make the infrastructure in Qiskit/documentation much simpler by avoiding adding special-case code.