A recent commit merged with a release note with invalid rST in a release
note. Our docs build currently sets the `branch` of the release notes
for the newest notes to be `main`, which causes new release notes in PRs
to be skipped during the PR CI, allowing potentially bad notes through.
* Collapse release notes for pre-releases (#11224)
* Collapse release notes for pre-releases
This commit tweaks the reno sphinx directive usage to collapse the
pre-releases. The big piece of this is splitting into using multiple
directives for each minor stable release branch. Each directive
explicitly sets the scanning branch to the stable branches. The
underlying issue with a single directive was that the reno git
scanner wasn't seeing the final release tags on main as the tags only
exist on the stable branches. The extra benefit of this is that we also
get the bugfix releases included now.
* Adjust reno pre-release tag regex
This commit adjusts the pre-release tag regex to match how qiskit tags
pre-releases. The default pre release regex is:
```
(?P<pre_release>\.v?\d+(?:[ab]|rc)+\d*)$
```
which for Qiskit's pre-release tag format, the `pre_release` match
includes the patch version. For example, `0.45.0rc1` matches as `0rc1`.
But the actual pre_release match should be `rc1`. This commit adjusts
the regex to work for qiskit's tag format, and also include support for
`pre` syntax (which is pep440 compatible) pre-releases.
(cherry picked from commit f3fb08990f)
# Conflicts:
# releasenotes/config.yaml
* Fix conflict, add new directives
* Restore regex update
* Update docs/release_notes.rst
* Change earliest version to 0.45.0rc1
* Change the other earliest version to 0.45.0rc1
* Propose title for unrelesed notes
* Update docs/release_notes.rst
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
---------
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Elena Peña Tapia <epenatap@gmail.com>
Co-authored-by: Elena Peña Tapia <57907331+ElePT@users.noreply.github.com>
* Revert "Revert to one release notes file (#10639)"
The change to the release notes organization is only needed for the
stable/0.25 branch longer term. Moving forward we'll have a different
release notes strategy likely using the reno sphinx extension directly.
In the short term this reverts to the previous state prior to #10639 as
while #10639 was necessary for getting 0.25.1 released it did turn off
our CI coverage testing that release notes would be built. Restoring
this is important so we know from CI whether a change to the release
notes works as part of the docs build.
This reverts commit 0388d543de.
* Sync release notes from 0.25.1
* Apply typo fix from #10711
This cross-repository merge unifies the documentation, benchmarks and
code of conduct from the metapackage into Qiskit/Terra's build.
There are very non-trivial merge conflicts that have been resolved by
this commit. The summary is:
- `CODE_OF_CONDUCT.md`: taken directly from the metapackage's version.
- `docs/conf.py`: strongly unified, albeit without the translations
components that are added in a separate commit.
- `docs/index.rst`: taken almost verbatim from the metapackage. All the
API documentation RST files on Terra are moved to `docs/apidoc`
(without the trailing 's') to match the metapackage expectation, so
the URLs of built documentation will not change.
- `docs/release_notes.rst`: The metapackage's version is renamed to
`docs/legacy_release_notes.rst`, given a small introductory header,
and made an orphan linked only from a _new_ `docs/release_notes.rst`
that uses `reno`.
- `docs/tutorials.rst`: Mostly these were the same already. Updated to
include Qiskit/Terra's correction that it's not an orphan, and contain
the metapackage's extra intro tutorial.
- `docs/apidoc/terra.rst`: renamed to `docs/apidoc/index.rst` and retitled
to be correctly just "API Documentation".
- `requirements-dev.txt`: the version of the Sphinx theme is bumped to 1.14
to match the metapackage expectation.
This removes many sections of the documentation that refer to the
metapackage as a whole, the elements of the metapackage, or refer to
Terra as Terra. This is intended to be in line with the new branding
decisions around the Qiskit project.
With the current community management structure still a little up in the
air, we are (at least temporarily) removing the repository-decision
flowchart from the documentation, since this documentation will
primarily be for Qiskit Terra. The contributor flowchart, or something
similar, may end up on the landing pages of the Ecosystem documentation,
or another community hub.
I've left references to "Terra" in place, because those should still
logically be removed as part of the general migration in naming within
the Terra repository. I've also left the build processes in place that
`git clone` Terra and the tutorials; we need those to continue having a
working docs build in this repo. They'll get modified as these files get
merge to Terra as well, but they need to stay alive here.
One of the notable removals is the API docs links to Aer and IBMQ from
the main page, since as of the deployed metapackage version (0.44),
those are no longer part of the metapackage.
FixQiskit/qiskit-metapackage#1787.
FixQiskit/qiskit-metapackage#1778 - mostly; the version logic is _way_ stripped down, and will
now automatically work on Terra at least as much as we need when the
files are merged.
FixQiskit/qiskit-metapackage#1667FixQiskit/qiskit-metapackage#1643
Bump the meta repo version to include:
qiskit-aer==0.12.1
---------
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
Co-authored-by: Luciano Bello <bel@zurich.ibm.com>
The release notes for the most recent release did not follow the
required template. This PR provides a fix.
Release 0.43.1 was made for this package because Terra 0.24.1 was
released. See PR Qiskit/qiskit-metapackage#1753.
Fixes the majority of docs failures, which are broadly these categories:
* Invalid references
* Invalid Sphinx syntax
* Config out of sync with qiskit-terra, e.g. missing doctest and qasm3 requirements.
We can't yet enable `sphinx-build -W` because there are some bigger issues still:
* Stop using `sphinx-redirects`: Qiskit/qiskit-metapackage#1738
* Fix an issue in the qiskit-tutorials repo, which should also be setting `-W` in its CI.
* pull migration guides from terra
* rename variable names to make them more explicit
* Bump Meta
Bump the meta repo version to include:
qiskit-terra==0.24.0
* Fix formatting
---------
Co-authored-by: Junye Huang <h.jun.ye@gmail.com>
* Bump version for qiskit-terra==0.23.3
Bump the meta repo version to include:
qiskit-terra==0.23.3
* Update release notes.
---------
Co-authored-by: Kevin Hartman <kevin@hart.mn>
* Bump version for qiskit-ibmq-provider==0.20.2
Bump the meta repo version to include:
qiskit-ibmq-provider==0.20.2
* Bump version for qiskit-aer==0.12.0
Bump the meta repo version to include:
qiskit-aer==0.12.0
* Add release notes
* Fix ibmq release note typo
---------
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-ibmq-provider==0.20.1
Bump the meta repo version to include:
qiskit-ibmq-provider==0.20.1
* Bump version for qiskit-terra==0.23.2
Bump the meta repo version to include:
qiskit-terra==0.23.2
* Add Terra 0.23.2 release notes
* Fixup release-notes headers
* Add release notes for ibmq-provider 0.20.1
Co-authored-by: Kevin Tian <kevin.tian@ibm.com>
* Fix trailing whitespace
---------
Co-authored-by: Julien Gacon <gaconju@gmail.com>
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
Co-authored-by: Kevin Tian <kevin.tian@ibm.com>
* Bump version for qiskit-ibmq-provider==0.20.0
Bump the meta repo version to include:
qiskit-ibmq-provider==0.20.0
* Bump version for qiskit-terra==0.23.1
Bump the meta repo version to include:
qiskit-terra==0.23.1
* Add terra release notes
* Add qiskit-ibmq-provider release notes
---------
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-terra==0.23.0
Bump the meta repo version to include:
qiskit-terra==0.23.0
* Add terra release notes
* Deprecate ibmq in the metapackage too
* Fix release note typo
* Tweak IBMQ metapackage deprecation note
Co-authored-by: Kevin Krsulich <kevin@krsulich.net>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Kevin Krsulich <kevin@krsulich.net>
* Bump version for qiskit-terra==0.22.4
Bump the meta repo version to include:
qiskit-terra==0.22.4
* add releasenotes
Co-authored-by: Julien Gacon <gaconju@gmail.com>
* Bump version for qiskit-aer==0.11.2
Bump the meta repo version to include:
qiskit-aer==0.11.2
* Add aer release notes
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-terra==0.22.3
Bump the meta repo version to include:
qiskit-terra==0.22.3
* Add Terra 0.22.3 release notes
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
* Bump version for qiskit-terra==0.22.2
Bump the meta repo version to include:
qiskit-terra==0.22.2
* Add Terra 0.22.2 release notes
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
* Bump version for qiskit-aer==0.11.1
Bump the meta repo version to include:
qiskit-aer==0.11.1
* Add qiskit-aer release notes
* Bump version for qiskit-terra==0.22.1
Bump the meta repo version to include:
qiskit-terra==0.22.1
* Add terra release notes
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-terra==0.22.0
Bump the meta repo version to include:
qiskit-terra==0.22.0
* Add terra release notes
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-aer==0.11.0
Bump the meta repo version to include:
qiskit-aer==0.11.0
* Add Aer 0.11.0 release notes
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
* Bump version for qiskit-terra==0.21.2
Bump the meta repo version to include:
qiskit-terra==0.21.2
* Add release notes for Terra 0.21.2
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
* Bump version for qiskit-terra==0.21.1
Bump the meta repo version to include:
qiskit-terra==0.21.1
* Add terra release notes
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
In Qiskit/qiskit-terra#8320 a mistake was fixed where a release note for
0.21.0 was committed to the wrong location in the repository. This
prevented the release notes from being shown when reno was called to
build the rst page. This commit adds the release notes to the published
copy now that this has been caught so the release notes are included
with the others in 0.21.0.
* Bump version for qiskit-ibmq-provider==0.19.2
Bump the meta repo version to include:
qiskit-ibmq-provider==0.19.2
* Add release notes for qiskit-ibmq-provider 0.19.2 (Qiskit/qiskit-metapackage#1556)
* Bump version for qiskit-terra==0.21.0
Bump the meta repo version to include:
qiskit-terra==0.21.0
* Add terra release notes
Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Remove qiskit-ignis from the metapackage
The next qiskit metapackage release (when terra releases 0.21.0) will
no longer include qiskit-ignis as the deprecation cycle has finished.
This commit removes the qiskit-ignis package from the metapackage,
deletes the documentation sections for ignis and adds a prelude
section for the release notes documenting the removal and manual
upgrade steps users might need to do.
* Avoid jupyter-execute ignis import in release notes
* Bump version for qiskit-terra==0.20.2
Bump the meta repo version to include:
qiskit-terra==0.20.2
* Bump version for qiskit-ignis==0.7.1
Bump the meta repo version to include:
qiskit-ignis==0.7.1
* Add release notes
* Update crossrefs to be Terra-specific
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
* Bump version for qiskit-ibmq-provider==0.19.1
Bump the meta repo version to include:
qiskit-ibmq-provider==0.19.1
* Bump version for qiskit-terra==0.20.1
Bump the meta repo version to include:
qiskit-terra==0.20.1
* Add release notes for qiskit-ibmq-provider 0.19.1 (Qiskit/qiskit-metapackage#1479)
* Add Terra release notes for 0.20.1. (Qiskit/qiskit-metapackage#1481)
* Remove trailing whitespace
* Update docs/release_notes.rst
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>
Co-authored-by: Kevin Hartman <kevin@hart.mn>
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-ibmq-provider==0.19.0
Bump the meta repo version to include:
qiskit-ibmq-provider==0.19.0
* Add release notes for qiskit-ibmq-provider 0.19.0 (Qiskit/qiskit-metapackage#1460)
* Add release notes for qiskit-ibmq-provider 0.19.0
* Fix links
* Bump version for qiskit-aer==0.10.4
Bump the meta repo version to include:
qiskit-aer==0.10.4
* Add Aer release notes
Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-terra==0.20.0
Bump the meta repo version to include:
qiskit-terra==0.20.0
* Add terra release notes
* Fix typos in terra release notes
Co-authored-by: Julien Gacon <gaconju@gmail.com>
* Bump Python minimum version
* Add new env variables to conf doc
* Fix doc lint
* Remove python 3.6 ci job
* Pin jinja2
* Add other packages to new release section
* Add dependabot to exclude list in authors file
* Update supported manylinux version
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Kevin Hartman <kevin@hart.mn>
Co-authored-by: Julien Gacon <gaconju@gmail.com>
* Bump version for qiskit-terra==0.19.2
Bump the meta repo version to include:
qiskit-terra==0.19.2
* Add terra release notes
* Bump version for qiskit-aer==0.10.3
Bump the meta repo version to include:
qiskit-aer==0.10.3
* Add aer release notes
* Update manylinux version for i686 on py310
* Mark Python 3.10 as supported in package metadata
* Clarify manylinux compatibility for python 3.10
* Ensure latest pip in CI test job
* Drop scipy constraint from ci
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-aer==0.10.2
Bump the meta repo version to include:
qiskit-aer==0.10.2
* Add release notes
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
* Bump version for qiskit-aer==0.10.0
Bump the meta repo version to include:
qiskit-aer==0.10.0
* Add Aer 0.10 release notes
* Bump version for qiskit-ibmq-provider==0.18.3
Bump the meta repo version to include:
qiskit-ibmq-provider==0.18.3
* Add IBMQ-provider 0.18.3 release notes (Qiskit/qiskit-metapackage#1386)
* Bump version for qiskit-aer==0.10.1
Bump the meta repo version to include:
qiskit-aer==0.10.1
* Add release notes for Aer 0.10.1
* Clarify double Aer release
Co-authored-by: Lev S. Bishop <18673315+levbishop@users.noreply.github.com>
* Bump minimum qiskit-experiments
This is to cause updates to the metapackage to update the version of
experiments as well.
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
Co-authored-by: Jessie Yu <jessieyu@us.ibm.com>
Co-authored-by: Lev S. Bishop <18673315+levbishop@users.noreply.github.com>
* Bump version for qiskit-ibmq-provider==0.18.2
Bump the meta repo version to include:
qiskit-ibmq-provider==0.18.2
* Release notes for ibmq-provider 0.18.2 (Qiskit/qiskit-metapackage#1376)
* Bump version for qiskit-terra==0.19.1
Bump the meta repo version to include:
qiskit-terra==0.19.1
* Add release note for Terra 0.19.1
* Reflow long release note line
Co-authored-by: Rathish Cholarajan <rathishc24@gmail.com>
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Co-authored-by: Jake Lishman <jake.lishman@ibm.com>
Thse section in the prelude for the 0.33.0 release contained a number of
copy and paste errors (as it was mostly copied from the deprecation note
in 0.25.0). This commit corrects those to make it clear that aqua has
been removed and you only need to uninstall aqua manually when upgrading
from a prior version.
* Bump version for qiskit-terra==0.19.0
Bump the meta repo version to include:
qiskit-terra==0.19.0
* Add terra release notes
* Bump version for qiskit-ignis==0.7.0
Bump the meta repo version to include:
qiskit-ignis==0.7.0
* Add ignis release notes
* Remove matplotlib pin
* Remove more matplotlib pinning
* Remove jupyter-execute from deprecated note syntax
* Remove stray tox.ini change
Co-authored-by: Matthew Treinish <mtreinish@kortar.org>
Eric Arellano