-
Notifications
You must be signed in to change notification settings - Fork 2.4k
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
Remove historical versions from release notes #11855
Conversation
One or more of the the following people are requested to review this:
|
docs/release_notes.rst
Outdated
|
||
.. release-notes:: | ||
:earliest-version: 0.45.0 | ||
:branch: stable/0.45 | ||
:earliest-version: 1.0.0.0rc1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't think of a way to automate this being "all the release notes since the last rc1 that started off a new minor series". I think this would need to be manually updated.
It doesn't seem like a big deal if we forget to update it, though, since these dev release notes will never hit production. What matters is this file being set up correctly for releases.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, minor releases are infrequent enough that it's probably not a big deal to leave it as a manual step.
Pull Request Test Coverage Report for Build 8562520123Warning: This coverage report may be inaccurate.This pull request's base commit is no longer the HEAD commit of its target branch. This means it includes changes from outside the original pull request, including, potentially, unrelated coverage changes.
Details
💛 - Coveralls |
@mtreinish gentle bump |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other than a small request for a comment, this is fine to me.
docs/release_notes.rst
Outdated
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% | ||
Qiskit |version| release notes | ||
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fwiw, the choice of punctuation doesn't affect what level of heading is generated, and we tend to use =====
under/over line in the API docs to be the L1 heading (though I know we use %%%%
under/over line in index.rst
). Not important either way, though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Cool, thanks!
* Remove historical versions from release notes * Bad version number * Review feedback (cherry picked from commit 2cbbe2b) # Conflicts: # docs/release_notes.rst
See #11840 for context.
Note that we don't include release notes for dev docs in docs.quantum.ibm.com, so these release notes won't hit production. This is instead intended to help Qiskit developers check that release notes are valid well in-advance of release prep.