-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Handle Qiskit release notes structure correctly to split out the notes by version #359
Comments
I'm thinking that the simplest solution will be for Qiskit to continue having only a single file Then we have the Qiskit devs configure Reno so that We need Qiskit devs to be okay with the plan, since they'd need to tweak the versions listed in cc @arnaucasau and @frankharkins |
We decided in the Qiskit dev meeting after talking this over with @ElePT, @jakelishman, and @mtreinish that the changes should happen in this repo, not in Qiskit/qiskit. They value building the historical release notes in their local builds more than I realized. They also do sometimes change prior release notes, such as fixing typos. It's important that Qiskit/documentation pulls in those changes, even if the release notes changed don't correspond to the current version of the docs we're building. For example, if we're building 1.1 docs, we should still see if there were any updates to 1.0 release notes. So, this issue now tracks us improving |
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>
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>
Follow up to #294 and #281.
@frankharkins found that it works well using the HTML generation script. A key change from Qiskit itself is we have one page per minor release, like
release-notes/0.45
. We need to make two improvements:release_notes
for all notes from Qiskit 0.45 forwardupdateApiDocs.ts
to handle new release notes automatically, including the wonkiness of the prior release note files (legacy_release_notes.html
).The text was updated successfully, but these errors were encountered: