Skip to content

Commit 46a7437

Browse files
Update documentation on setting reno's earliest-version (backport Qiskit#15243) (Qiskit#15256)
* Update documentation on setting reno's `earliest-version` (Qiskit#15243) The important thing for `reno` is that it pulls in _all_ pre-releases in the given minor cycle. That doesn't always mean starting at `rc1`; sometimes we make "beta" preview releases, and we still want to include release notes that came in before those tags. If we ever made an "alpha" tag, we'd want to include that too. (cherry picked from commit 882e3ca) * Fix broken release-notes cross-references --------- Co-authored-by: Jake Lishman <[email protected]>
1 parent caf287c commit 46a7437

File tree

2 files changed

+18
-7
lines changed

2 files changed

+18
-7
lines changed

docs/release_notes.rst

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,20 @@ Qiskit |version| release notes
55
==============================
66

77
..
8-
These release notes get converted into Markdown files via the infrastructure at https://github.com/Qiskit/documentation, which then gets deployed to https://quantum.cloud.ibm.com/docs/api/qiskit/release-notes. Changes to these release notes will update those release notes the next time the API docs are generated for this version.
8+
These release notes get converted into Markdown files via the infrastructure at
9+
https://github.com/Qiskit/documentation, which then gets deployed to
10+
https://quantum.cloud.ibm.com/docs/api/qiskit/release-notes. Changes to these release notes will
11+
update those release notes the next time the API docs are generated for this version.
912
10-
`:earliest-version:` should be set to the rc1 release for the current minor release series. For example, the stable/1.1 branch should set it to 1.1.0rc1. If on `main`, set to the prior minor version's rc1, like `1.0.0rc1`.
13+
You should set `earliest-version` to:
14+
15+
* if on a `stable` branch, then the _earliest_ tagged release of the minor series. For
16+
`stable/2.1` this would be `2.1.0rc1`. For `stable/2.2` this would be `2.2.0b1`. Typically
17+
you should update this as part of making the `x.y.0` "final" release (e.g. when tagging
18+
`2.2.0` or `2.3.0`).
19+
* if on `main`: it doesn't matter all too much; it just affects how many old release notes
20+
are built and tested as part of the release. It still needs to be a tag reachable on `main`,
21+
though, which is typically `rc1` tags.
1122

1223
.. release-notes::
13-
:earliest-version: 2.2.0rc1
24+
:earliest-version: 2.2.0b1

releasenotes/notes/2.2/cbindgen-usize-to-size_t-544294518fdfcbb0.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
upgrade_c:
33
- |
4-
Most usage of `uintptr_t`` has been changed to ``size_t``. Specifically the following usages have been changed:
4+
Most usage of ``uintptr_t`` has been changed to ``size_t``. Specifically the following usages have been changed:
55
6-
* :c:member:`QkOpCount::count`
7-
* :c:member:`QkOpCounts::len`
8-
* :c:member:`QkObsTerm::len`
6+
* :c:member:`QkOpCount.count`
7+
* :c:member:`QkOpCounts.len`
8+
* :c:member:`QkObsTerm.len`
99
* The return type of :c:func:`qk_circuit_num_instructions`.
1010
* The ``index`` argument in :c:func:`qk_circuit_get_instruction`.
1111
* The ``boundaries`` argument in :c:func:`qk_obs_new`.

0 commit comments

Comments
 (0)