Forward port release notes changes from stable/1.0 #11819
Conversation
|
One or more of the the following people are requested to review this:
|
Pull Request Test Coverage Report for Build 8100530390Details
💛 - Coveralls |
Oh good catch, yeah we should add the categories. We weren't doing that because previously we had avoided adding a git version of reno to the requirements-dev.txt file on main. The risk is if anyone is using a released version of reno they'll hit an error because the config syntax for categories isn't supported on a reno release yet (let me ask on IRC if there is any appetite for a new reno release soon). |
In the rush to get 1.0.0rc1 release on time, we missed migrating the release notes from the root of the notes directory to the 1.0/ subdirectory. Doing this is convenient because it makes it easier to associate notes with a particular minor/major release which is useful for navigating potential issues with reno's history scan. This commit forward ports the state of the stable/1.0 branches release notes to main. This will make it much easier to differentiate which release notes are associated with 1.1 instead of 1.0.
0affcd0 to
0b10f34
Compare
There was a problem hiding this comment.
This looks ok to me. It's going to turn reno new --edit into a nuisance to use for a bit, I think, because there's going to be like 200 sections in it to delete.
Two thoughts:
- We might need to advertise this change to Qiskit developers, including potentially updating the contributing instructions?
- Ought we to section the release notes that have merged to
mainsince 1.0 but aren't being backported in this PR, or shall we do it in a follow-up?
I'm somewhat keen to get the sectioning done at the point of merge - it's less work to do at the time of a release.
Oh that reminds me we maybe need to add a
I think we can do this in a follow up too. I was hoping to keep this PR mostly mechanical as ensuring the changes we made to release notes from
I think lets do this in a follow up. |
* Forward port release notes changes from stable/1.0 In the rush to get 1.0.0rc1 release on time, we missed migrating the release notes from the root of the notes directory to the 1.0/ subdirectory. Doing this is convenient because it makes it easier to associate notes with a particular minor/major release which is useful for navigating potential issues with reno's history scan. This commit forward ports the state of the stable/1.0 branches release notes to main. This will make it much easier to differentiate which release notes are associated with 1.1 instead of 1.0. * Add reno subsection config
Summary
In the rush to get 1.0.0rc1 release on time, we missed migrating the release notes from the root of the notes directory to the 1.0/ subdirectory. Doing this is convenient because it makes it easier to associate notes with a particular minor/major release which is useful for navigating potential issues with reno's history scan. This commit forward ports the state of the stable/1.0 branches release notes to main. This will make it much easier to differentiate which release notes are associated with 1.1 instead of 1.0.
Details and comments
This is a partial forward port of #11760 all of the changes made here were part of that PR. #11760 just included larger changes to prepare the 1.0 release so this PR wasn't done with a normal cherry pick or via the mergify bot to avoid porting over the unnecessary pieces of #11760.