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.0.0 release #11760

Merged
merged 28 commits into from
Feb 15, 2024
Merged

Prepare 1.0.0 release #11760

merged 28 commits into from
Feb 15, 2024

Conversation

mtreinish
Copy link
Member

@mtreinish mtreinish commented Feb 9, 2024

Summary

This commit prepares the repo for the 1.0.0 release. It migrates all the release notes to a dedicated directory to differentiate those notes from future notes (this will need to be forward ported to the main branch), updates the version numbers to indicate it is the final 1.0.0 release, and updates the release notes to prepare them for publishing. Once this merges this commit should be used to tag the 1.0.0 release.

Details and comments

TODO:

  • Wait for the final PRs of the release to merge
  • Finish prelude draft
  • Go through and copy-edit and update the release notes

@mtreinish mtreinish added on hold Can not fix yet documentation Something is not clear or an error documentation Changelog: None Do not include in changelog labels Feb 9, 2024
@mtreinish mtreinish added this to the 1.0.0 milestone Feb 9, 2024
@mtreinish mtreinish requested a review from a team as a code owner February 9, 2024 00:10
@qiskit-bot
Copy link
Collaborator

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

@mtreinish mtreinish changed the title Prepare 1.0.0 release [WIP] Prepare 1.0.0 release Feb 9, 2024
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.

I've taken a look and left some suggestions, hopefully they make sense. I still need to take a look at the release highlights section and last paragraph.

releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
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.

Part 2

releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
Comment on lines +42 to +50
* The :class:`.QuantumCircuit` class's internal :attr:`~.QuantumCircuit.data`
structure has been rewritten in Rust to greatly improve the memory efficiency
of the :class:`.QuantumCircuit` objects by caching the arguments of the
instructions.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe link to the rust docs or project repo too?

Suggested change
* The :class:`.QuantumCircuit` class's internal :attr:`~.QuantumCircuit.data`
structure has been rewritten in Rust to greatly improve the memory efficiency
of the :class:`.QuantumCircuit` objects by caching the arguments of the
instructions.
* The :class:`.QuantumCircuit` class' internal :attr:`~.QuantumCircuit.data`
structure has been rewritten in Rust to greatly improve the memory efficiency
of the :class:`.QuantumCircuit` objects by caching the arguments of the
instructions.

Copy link
Member Author

Choose a reason for hiding this comment

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

So I think the apostrophe usage here is actually correct as class isn't plural.

As for the rust docs we don't actually publish any documentation about the rust code in Qiskit as it's all explicitly internal. Or did you mean link to the rust language documentation (like: https://doc.rust-lang.org/book/)?

Copy link
Contributor

@jlapeyre jlapeyre Feb 13, 2024

Choose a reason for hiding this comment

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

There seems to be more than one convention on this, and sometimes non-plurals get s instead of '. Even so, none of the conventions I found favor class' over class's.

releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
Copy link
Contributor

@sbrandhsn sbrandhsn left a comment

Choose a reason for hiding this comment

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

LGTM, I wonder whether we should include one "flashy" sentence along the lines of: Only the new major version (Qiskit 1.x series) will continue to receive performance improvements such as highlighted in (LINK) and new functionality that increases the productivity in working with quantum computers

releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
release relate to the stability policy, release cycles, and versioning.
Qiskit is now formally using `semantic versioning <https://semver.org/>`__ ,
and this means that, for the entire lifecycle of the 1.x release series, the project
is commited to maintaining backwards compatibility. We're also now starting
Copy link
Contributor

Choose a reason for hiding this comment

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

I think one more sentence about backwards compatibility would be nice here: do we commit to only reading the output (e.g. quantum circuits) written by earlier Qiskit versions or do we commit to some API, i.e. guarantee that user code will run correctly for the entire lifecycle of a major release?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'll come up with something. I was trying to avoid rehashing the entire contents of the documentation on this topic (which is what I ended up doing in my initial draft), but I definitely can see the value in explaining a bit more about what backwards compatibility means here.

releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
sbrandhsn
sbrandhsn previously approved these changes Feb 12, 2024
Copy link
Member

@1ucian0 1ucian0 left a comment

Choose a reason for hiding this comment

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

I would remove the This page contains the release notes for Qiskit, starting from Qiskit 0.45, the first time that Qiskit and Qiskit Terra had the same versions. in docs/release_notes.rst:7

releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated 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.

I've only read over the prelude of the release - I think we've already got enough people looking through everything else as well.

I agree with the top-level features that have been highlighted, and I couldn't think of anything else I'd want to promote up to those top-level bullets either.

releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
releasenotes/notes/1.0/prepare-1.0-e13b9b8273055775.yaml Outdated Show resolved Hide resolved
@mtreinish mtreinish changed the title [WIP] Prepare 1.0.0 release Prepare 1.0.0 release Feb 14, 2024
@mtreinish mtreinish removed the on hold Can not fix yet label Feb 15, 2024
mtreinish and others added 8 commits February 15, 2024 13:49
This commit prepares the repo for the 1.0.0 release. It migrates all the
release notes to a dedicated directory to differentiate those notes from
future notes (this will need to be forward ported to the main branch),
updates the version numbers to indicate it is the final 1.0.0 release,
and updates the release notes to prepare them for publishing. Once this
merges this commit should be used to tag the 1.0.0 release.
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
Co-authored-by: Sebastian Brandhofer <148463728+sbrandhsn@users.noreply.github.com>
* InverseModifier

* add-commutation-library

* Update add-commutation-library-88b7ff65b3d35f9a.yaml

---------

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* InverseModifier

* add-commutation-library

* Update add-commutation-library-88b7ff65b3d35f9a.yaml

* add-commutation-library

* .

* .

* .

* .

* Use iso8601 for dates

---------

Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
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.

Ok, assuming this passes the docs build, I think this is it for Qiskit 1.0.0.

@jakelishman jakelishman merged commit 21b11b9 into Qiskit:stable/1.0 Feb 15, 2024
11 checks passed
@mtreinish mtreinish deleted the prepare-1.0 branch February 15, 2024 21:34
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

9 participants