Qiskit / qiskit-ibm-runtime / 8288165357

83%

push

github

Switch from Reno to Towncrier for release notes (#1501)

## Why Reno broke

Closes https://github.com/Qiskit/documentation/issues/979 and https://github.com/Qiskit/documentation/issues/978.

Reno stopped working correctly with Runtime 0.21. The release notes for 0.16+ were all being included in the 0.15 release note entry, incorrectly. https://github.com/Qiskit/qiskit-ibm-runtime/pull/1486 attempted to fix this and it worked locally, but in CI the `stable/0.15` entry was missing all release notes before 0.15 and we could not figure out how to fix that.

Reno got into a bad state because of the feature branch `experimental-0.2`. That branch was based off of `main` at the time of 0.15.0. It was not merged back into `main` until preparing 0.21.0 when we merged 32b0dbc36 into `main` . During the feature branch's life, <a class=hub.com/Qiskit/qiskit-ibm-runtime/commit/ec8f5a4953a654536148d9ce66f6cca1db3156b3">ec8f5a495 merged main into experimental-0.2, which we think messed things up by copying over Git tags into the feature branch. `git log --tags --simplify-by-decoration` shows all the tags in order, but between 0.20.0 and 0.21.0 is that commit ec8f5a4953a654536148d9ce66f6cca1db3156b3.

We think the problem is that Reno gets confused when you merge a branch that itself has Git tags back into `main`. This [blog warns](https://medium.com/opsops/software-discovery-reno-b072827ad883)

> There is one case when reno may skip release note, and it’s a single known ‘don’t do it’ case, documented and articulated: Do not merge stable branch with release tags back into master branch.

We think Reno ended up confusing some of the same Git tags between the feature branch and main.

We could not think of a safe fix for Reno because we cannot safely force push changes to the Git history. We couldn't find a way to teach Reno which release notes correspond to which version because it tries automating this all via Git.

## Switching to Towncrier

[Towncrier](https://towncrier.readthe... (continued)

5769 of 7010 relevant lines covered (82.3%)

12.23 hits per line