Move release note in wrong location and add script to block this

[mtreinish]

Summary

In #8201 I added a release note as part of the PR which documented the
change in behavior. However, I accidentally committed this file in the
wrong location (by running reno new outside of the repo root). This
meant the file was never actually included in the release notes for the
0.21.0 release. This commit corrects this oversight and moves it back to
the proper location.

However, since this isn't my first time making this mistake and I can
expect that others will make it too in the future. This commit also adds
a new script to detect this and raise an error when release notes are
present outside of the proper location. By running this as part of lint
jobs we'll block this mistake from happening again.

Details and comments

[qiskit-bot]

Thank you for opening a new pull request.

Before your PR can be merged it will first need to pass continuous integration tests and be reviewed. Sometimes the review process can be slow, so please be patient.

While you're waiting, please feel free to review other open PRs. While only a subset of people are authorized to approve pull requests for merging, everyone is encouraged to review open pull requests. Doing reviews helps reduce the burden on the core team and helps make the project's code better for everyone.

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

• @Qiskit/terra-core

[nkanazawa1989]

Thanks Matthew. This looks good to me. Just few questions. I'll hold my approval since I'm not quite familiar with linter mechanism.

[nkanazawa1989]

How this variable is used?

[mtreinish]

oh, good catch. this is sloppy copy and paste from the script I based this on

[nkanazawa1989]

This works in every platform?

[mtreinish]

Yeah it will, because I have the if __name__ = "__main__" on the script. Without this windows and macOS > 3.7 would potentially have issues because they default to the spawn method.

[jakelishman]

Will the hard-coded / in the regexes work correctly on Windows (not that this is a blocker, if we only care about running in CI). Alternatively, if multiprocessing isn't such a big deal, something like

import pathlib

for directory in pathlib.Path(".").glob(f"qiskit/**/releasenotes/notes"):
    print("error", ...)

might be simpler and faster, since it should only look in things with a releasenotes directory, and not every other file.

[jakelishman]

(I don't know why I wrote pathlib.Path(".").glob("qiskit/**/...") instead of pathlib.Path("qiskit").rglob("releasenotes/notes"), but whatever.)

[coveralls]

Pull Request Test Coverage Report for Build 2656050807

• 0 of 0 changed or added relevant lines in 0 files are covered.
• 3 unchanged lines in 1 file lost coverage.
• Overall coverage decreased (-0.005%) to 83.992%

---

Files with Coverage Reduction	New Missed Lines	%
qiskit/pulse/library/waveform.py	3	89.36%

Totals
Change from base Build 2655887472:	-0.005%
Covered Lines:	55826
Relevant Lines:	66466

---

💛 - Coveralls

[mtreinish]

Hmm, I always forget about windows. We do want people to run this locally. I'm not sure what the git output looks like for ls-tree on windows. I'll spin up my VM and check.

I debated between just doing things by local path and via the git tracked file approach. But I figured doing the git tracked would be a bit better just because reno worked on the git log. I always forget about pathlib which is fast IIRC. I'll play around locally and push up a change if II like that approach better.

[jakelishman]

Looks fine to me.

[jakelishman]

I approved as-is, but if you want to make some changes, that's fine too. To be honest, I wonder if our lint tox job would work well on a general Windows machine already - it launches a bunch of Python scripts trusting that their #! lines will execute them (unless tox does something clever), and since those call to /usr/bin/env python3, I dunno if that'll work well on Windows anyway.

[mtreinish]

I tested this on my windows vm and tox -elint does work on windows (I tested from the windows cmd.exe). The only thing I had to do manually was install jax, symengine, scikit-quant, and sqsnobfit which didn't get pulled in because of the environment markers in the requirements list (and pylint failed because of the missing dependencies).