Skip to content
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

Merged
merged 5 commits into from
Apr 5, 2024

Conversation

Eric-Arellano
Copy link
Collaborator

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.

@Eric-Arellano Eric-Arellano requested a review from a team as a code owner February 21, 2024 18:38
@qiskit-bot
Copy link
Collaborator

One or more of the the following people are requested to review this:


.. release-notes::
:earliest-version: 0.45.0
:branch: stable/0.45
:earliest-version: 1.0.0.0rc1
Copy link
Collaborator Author

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.

Copy link
Member

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.

@Eric-Arellano Eric-Arellano added documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Feb 21, 2024
@coveralls
Copy link

coveralls commented Feb 26, 2024

Pull Request Test Coverage Report for Build 8562520123

Warning: 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

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 417 unchanged lines in 38 files lost coverage.
  • Overall coverage increased (+0.008%) to 89.388%

Files with Coverage Reduction New Missed Lines %
qiskit/synthesis/evolution/qdrift.py 1 93.55%
qiskit/primitives/backend_estimator_v2.py 2 97.84%
qiskit/circuit/library/generalized_gates/rv.py 2 85.71%
qiskit/circuit/library/arithmetic/quadratic_form.py 2 97.01%
qiskit/circuit/library/standard_gates/u.py 2 97.8%
qiskit/synthesis/unitary/qsd.py 2 97.54%
qiskit/quantum_info/operators/symplectic/random.py 3 97.74%
qiskit/synthesis/two_qubit/xx_decompose/circuits.py 3 93.88%
qiskit/visualization/counts_visualization.py 3 77.78%
qiskit/synthesis/unitary/aqc/fast_gradient/fast_gradient.py 3 96.58%
Totals Coverage Status
Change from base Build 8554012050: 0.008%
Covered Lines: 60305
Relevant Lines: 67464

💛 - Coveralls

@Eric-Arellano
Copy link
Collaborator Author

@mtreinish gentle bump

Copy link
Member

@jakelishman jakelishman left a 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.

Comment on lines 3 to 5
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Qiskit |version| release notes
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
Copy link
Member

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.

docs/release_notes.rst Show resolved Hide resolved
Copy link
Member

@jakelishman jakelishman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool, thanks!

@jakelishman jakelishman enabled auto-merge April 4, 2024 23:20
@jakelishman jakelishman added the stable backport potential The bug might be minimal and/or import enough to be port to stable label Apr 4, 2024
@jakelishman jakelishman added this pull request to the merge queue Apr 5, 2024
Merged via the queue into Qiskit:main with commit 2cbbe2b Apr 5, 2024
12 checks passed
mergify bot pushed a commit that referenced this pull request Apr 5, 2024
* Remove historical versions from release notes

* Bad version number

* Review feedback

(cherry picked from commit 2cbbe2b)

# Conflicts:
#	docs/release_notes.rst
@Eric-Arellano Eric-Arellano deleted the EA/release-notes-main branch April 5, 2024 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Changelog: None Do not include in changelog documentation Something is not clear or an error documentation stable backport potential The bug might be minimal and/or import enough to be port to stable
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants