Skip to content

Conversation

mtreinish
Copy link
Member

@mtreinish mtreinish commented Feb 1, 2024

Summary

This commit prepares the 0.46.0 release, this involves 2 steps first changing all the version numbers to 0.46.0 from 0.45.x and secondly updating the release notes to prepare them for publishing.

There are some larger than normal changes to the release notes made in this PR. Because of the nature of how 0.46 was developed in parallel to 0.45.x, the merge commits used to sync changes from stable/0.45 to stable/0.46 cause reno to be unable to determine which tag a release note is associated with reliably. To ensure reno is able to determine all the 0.46.0 release notes go together this commit squashes all the applicable release notes into a single new file (along with adding a prelude). As part of this process the release notes were edited for consistency and accuracy. Some other changes to note are:

  • The release note about the deprecation of qobj input to UnitarySimulatorPy was removed as it's been subsumed by the deprecation of UnitarySimulatorPy
  • The release note about the removal of the deprecated clifford_decompose and cnotdihedral_decompose was removed and those functions were restored as breaking API changes were not allowed in this release. Similarly the qiskit.synthesis.Quaternion path was restored.
  • Bumped the cibuildwheel version used to build wheels to v2.16.5 which is needed to fix compatibility with newer powershell releases now that the Github actions windows images bumped the powershell version installed.

Details and comments

TODO:

  • Wait for last PRs to merge and then rebase on top
  • Finish going through release notes and updating.

@mtreinish mtreinish added on hold Can not fix yet Changelog: None Do not include in changelog labels Feb 1, 2024
@mtreinish mtreinish added this to the 0.46.0 milestone Feb 1, 2024
@qiskit-bot
Copy link
Collaborator

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

from qiskit.quantum_info.quaternion import Quaternion

from .cnotdihedral_decompose import decompose_cnotdihedral
from .clifford_decompose import decompose_clifford
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure that you need to add clifford_decompose and cnotdihedral_decompose, since they were deprecated in a previous release.
Quaternion was moved inside quantum_info.

Copy link
Member Author

Choose a reason for hiding this comment

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

This is true, but I'm restoring them here because 0.46.0 is special. We're documenting this release as being fully compatible with 0.45.x and it's primarily about just adding the deprecation warnings for API changes coming in 1.0.0. Removing these as part of 0.46.0 would break that messaging because if someone was still using the deprecated qiskit.quantum_info.synthesis.clifford_decompose() function when they upgraded from 0.45.2 to 0.46.0 it would break. If 0.46.0 was a normal minor version release this would have been totally fine, 0.46.0 is really just a special edge case as the last minor version in the 0.* release series.

Copy link
Contributor

@ElePT ElePT left a comment

Choose a reason for hiding this comment

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

Here is a first pass on the release notes, mostly typos. One comment is that the CI artifact I used to check the rendered notes didn't seem to catch this new file, the prelude didn't show up and they were labeled as 0.45.0-34:

Screenshot 2024-02-01 at 14 37 12

Anyways, the text is the same so it was still helpful, and it might have been my bad, just wanted to raise it in case it was not my bad.

@mtreinish
Copy link
Member Author

One comment is that the CI artifact I used to check the rendered notes didn't seem to catch this new file, the prelude didn't show up and they were labeled as 0.45.0-34:

This is an artifact of the release_notes.rst pointing to the branch stable/0.46:
https://github.com/Qiskit/qiskit/pull/11697/files#diff-d778557532960c8ff205506cdecb469236ec50ca060b2da4c0b9843533a43f1a
it will render the release notes from whatever your local branch with that name is

Copy link
Contributor

@Cryoris Cryoris left a comment

Choose a reason for hiding this comment

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

Few typos and lots of nitpicks 🙂

mtreinish and others added 8 commits February 1, 2024 12:16
This commit prepares the 0.46.0 release, this involves 2 steps first
changing all the version numbers to 0.46.0 from 0.45.x and secondly
updating the release notes to prepare them for publishing.

There are some larger than normal changes to the release notes made in
this PR. Because of the nature of how 0.46 was developed in parallel to
0.45.x, the merge commits used to sync changes from stable/0.45 to
stable/0.46 cause reno to be unable to determine which tag a release
note is associated with reliably. To ensure reno is able to determine
all the 0.46.0 release notes go together this commit squashes all the
applicable release notes into a single new file (along with adding a
prelude). As part of this process the release notes were edited for
consistency and accuracy. Some other changes to note are:

 - The release note about the deprecation of qobj input to
   UnitarySimulatorPy was removed as it's been subsumed by the
   deprecation of UnitarySimulatorPy
 - The release note about the removal of the deprecated
   `clifford_decompose` and `cnotdihedral_decompose` was removed and
   those functions were restored as breaking API changes were not
   allowed in this release. Similarly the qiskit.synthesis.Quaternion
   path was restored.
 - Bumped the cibuildwheel version used to build wheels to v2.16.5 which
   is needed to fix compatibility with newer powershell releases now
   that the Github actions windows images bumped the powershell version
   installed.
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: Julien Gacon <gaconju@gmail.com>
@mtreinish mtreinish removed the on hold Can not fix yet label Feb 1, 2024
@mtreinish
Copy link
Member Author

I think this is ready for review so we can tag 0.46.0 once it's merged. The only open question is if we need to do anything related to: #11512 (comment)

@mtreinish mtreinish requested review from a team and nonhermitian as code owners February 1, 2024 18:31
@jakelishman jakelishman linked an issue Feb 1, 2024 that may be closed by this pull request
@jakelishman
Copy link
Member

I pushed up a commit that adds a timeline into all the decorators. There's other use of DeprecationWarning where I added a timeline, but not all - just too much.

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.

I didn't read the release notes fully, but looks like Elena and Julien did, and we can fix that after merge if necessary anyway.

Copy link
Contributor

@ElePT ElePT left a comment

Choose a reason for hiding this comment

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

Approving the renos.

@mtreinish mtreinish enabled auto-merge February 1, 2024 19:41
@mtreinish mtreinish disabled auto-merge February 1, 2024 19:41
@mtreinish mtreinish merged commit 9aa4888 into Qiskit:stable/0.46 Feb 1, 2024
@mtreinish mtreinish deleted the prepare-0.46.0 branch February 1, 2024 20:22
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix deprecation messages for 0.46 release
6 participants