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

Prepare 1.3.0 release #13447

Merged
merged 38 commits into from
Nov 28, 2024
Merged

Prepare 1.3.0 release #13447

merged 38 commits into from
Nov 28, 2024

Conversation

raynelfss
Copy link
Contributor

@raynelfss raynelfss commented Nov 15, 2024

  • Move loose release notes.

Summary

The following commits set the version number on stable/1.3 to 1.3.0 in preparation for the 1.3.0 final release.

Details and comments

The following commits will:

  • Set the version number to 1.3.0.
  • Consolidate any loose release notes into the releasenotes/notes/1.3/ folder.
  • Update the cargo dependencies.
  • Fix any typos, broken links, and bad references in the folder releasenotes/notes/1.3/.
  • Include a prelude release note for the release.

@raynelfss raynelfss added on hold Can not fix yet Changelog: None Do not include in changelog labels Nov 15, 2024
@raynelfss raynelfss added this to the 1.3.0 milestone Nov 15, 2024
@raynelfss raynelfss requested a review from a team as a code owner November 15, 2024 20:11
@qiskit-bot
Copy link
Collaborator

One or more of the following people are relevant to this code:

Copy link
Collaborator

@beckykd beckykd left a comment

Choose a reason for hiding this comment

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

Lots of good stuff! let me know if you have any questions!

@raynelfss
Copy link
Contributor Author

I have checked all release notes to the best of my abilities now. @beckykd feel free to further review these. I should be posting the prelude release note sometime tomorrow.

@raynelfss raynelfss added the ci: test wheels Run the wheel-build scripts as an additional CI run for this PR label Nov 20, 2024
Copy link
Collaborator

@beckykd beckykd left a comment

Choose a reason for hiding this comment

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

I think I'm through everything! Thanks for putting them all together and doing that initial edit!

Copy link
Collaborator

Choose a reason for hiding this comment

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

I'm not sure what the term "inlined" means. Can you rephrase?
"inlined onto the base circuit"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe it's just mentioning how it's realigning new instructions onto a base circuit. Maybe the word re-align works better?

Copy link
Member

Choose a reason for hiding this comment

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

"Inline" is a compiler term

Copy link
Member

Choose a reason for hiding this comment

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

But also I think that note is from some prior release?

releasenotes/notes/1.3/storage-var-a00a33fcf9a71f3f.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/storage-var-a00a33fcf9a71f3f.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/storage-var-a00a33fcf9a71f3f.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/storage-var-a00a33fcf9a71f3f.yaml Outdated Show resolved Hide resolved
@raynelfss raynelfss force-pushed the prepare-1.3 branch 2 times, most recently from 6dffa85 to b1e08f8 Compare November 25, 2024 16:11
Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

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

Thanks for doing this, I've done a quick first pass through the notes but I still need to read the rendered output in sphinx to see how the complete notes read. From this first pass though I have a few concerns before I feel this is ready to merge and subsequently tagging the release.

The first is there are some notes that are already published on prior releases we need to delete those files from the stable/1.3 branch in this PR to avoid duplicating them. You can just git rm these files, but please do an audit of all the notes in the rendered output to make sure none exist on https://docs.quantum.ibm.com/api/qiskit/release-notes/1.2 or https://docs.quantum.ibm.com/api/qiskit/release-notes/1.1

The second large concern is around how we're documenting performance improvements. We are very inconsistent about how we're reporting speedups across the board. A lot of synthesis functions are called out individually as having been ported to rust and citing a speedup factor. While for the transpiler passes only some do this, the basis translator stands out prominently as being one of the few that did this. If we're going to call these out as feature notes we should be consistent and ensure we do it for all of them. Or if we feel it's not important to document them individually as a long list it is probably better to consolidate the multiple notes into a single note for passes that lists out the passes we've ported to rust and they're generally faster. We should do the same thing for synthesis functions too. Personally I think a single large note documenting all of them is better for readers than doing a lot of small notes.

A smaller thing is I feel like many release notes were not checked over for completeness or correct categorization and we should ensure this is all correct before publishing the release notes.

releasenotes/notes/1.3/storage-var-a00a33fcf9a71f3f.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/prepare-1.3.0-7c45598775fc2bbf.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/prepare-1.3.0-7c45598775fc2bbf.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/prepare-1.3.0-7c45598775fc2bbf.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/prepare-1.3.0-7c45598775fc2bbf.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/add-qpy-v13-3b22ae33045af6c1.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/add-qpy-v13-3b22ae33045af6c1.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.3/add-qpy-v13-3b22ae33045af6c1.yaml Outdated Show resolved Hide resolved
Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

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

Thanks for updating things. I started with the updated prelude, it is looking much better. Just have some small wording suggestions or missing details in suggestions

- Restored some deleted release notes.
- Fix formatting issues.
raynelfss and others added 4 commits November 27, 2024 17:05
Due to how we end up branching 1.2.0 without a tag this is confusing
reno's version detection because on the stable/1.3 branch there is no
tag before 1.3.0b1 associated with any of the release notes for 1.2.0.
This commit just removes all the release notes to fix this.

Additionally, this corrects the earliest-version field in the sphinx
directive for reno so we include the notes associated with 1.3.0b1.
mtreinish
mtreinish previously approved these changes Nov 27, 2024
Copy link
Member

@mtreinish mtreinish left a comment

Choose a reason for hiding this comment

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

I think this looks good now, while probably not perfect (no release's documentation is ever perfect) it's definitely looking really good to me now.. Thanks for all the work on polishing it and updating all the notes and also shepherding the 1.3.0 release.

@mtreinish mtreinish enabled auto-merge November 27, 2024 23:26
@mtreinish mtreinish added this pull request to the merge queue Nov 28, 2024
Merged via the queue into Qiskit:stable/1.3 with commit cda7ef6 Nov 28, 2024
25 checks passed
@raynelfss raynelfss deleted the prepare-1.3 branch December 2, 2024 15:37
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 ci: test wheels Run the wheel-build scripts as an additional CI run for this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants