Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add reno ci #506

Merged
merged 17 commits into from
Jan 17, 2024
Merged

Add reno ci #506

merged 17 commits into from
Jan 17, 2024

Conversation

taalexander
Copy link
Contributor

Summary

Are you changing the specification? This PR needs to be approved by the TSC members.
No

Are you changing the grammar to adjust to the specification?
No

Details and comments

Closes #328

@taalexander
Copy link
Contributor Author

The test is to make sure it fails CI until I add a reno.

@taalexander
Copy link
Contributor Author

taalexander commented Jan 11, 2024

Confirmed this is behaving as expected and ready for review:

output: Reno added or updated: releasenotes/notes/add-releasenote-checks-78194cf9de8ded3e.yaml

Copy link
Contributor

@hodgestar hodgestar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

I suggested a few things that seemed like small improvements to me.

When I run reno report it generates a report for ast-py/v0.5.0-19 which is rather odd. Partially this is because of the old tag names in the repository, but I'm not sure what the -19 is about. Can we do anything about this in this PR? Or do we just need to fix things when we sort out the release process itself?

.github/workflows/validate-releasenotes.yml Outdated Show resolved Hide resolved
.github/workflows/validate-releasenotes.yml Outdated Show resolved Hide resolved
.github/workflows/validate-releasenotes.yml Outdated Show resolved Hide resolved
.github/renos_updated.sh Outdated Show resolved Hide resolved
@taalexander
Copy link
Contributor Author

Reno report looks ok for me.

=============
Release Notes
=============

.. _Release Notes_3.0-225:

3.0-225
=======

.. _Release Notes_3.0-225_New Features:

New Features
------------

.. releasenotes/notes/add-releasenote-checks-78194cf9de8ded3e.yaml @ b'c44c713ed42eafbd7d9d87340ec41891113cbc37'

- Added CI support for ensuring contributions include a release note.
  If this is not desired for a PR the tag "no-reno" may be added to the
  PR.


.. _Release Notes_3.0-225_Upgrade Notes:

Upgrade Notes
-------------

.. releasenotes/notes/clarify-physical-qubits-f720f21a3d792c70.yaml @ b'782c3b6986e5ff46757a8867c39bf6f9acac603b'

- Improve physical qubit documentation. Define what constitutes a valid
  physical identifier, define physical circuits, and answer several questions
  about what a compiler may do with physical qubits.

.. releasenotes/notes/drop-dollar-from-pulse-wildcard-2efa545932ed7736.yaml @ b'ce7548adcf1b34941df112f8ecb1194726fd9acd'

- The "wildcard" identifiers in pulse grammars are now regular OpenQASM 3
  identifiers, without the leading dollar sign (``$``), *e.g.* what was ``$q``
  before is now simply ``q``.  Precise hardware qubits are still referenced
  as ``$0``, for example.  This was made for better consistency in identifiers;
  having the dollar sign in the wildcard carried no information, since it
  applied to any qubit already.

@hodgestar
Copy link
Contributor

@taalexander Approved. Could you tell me a bit more about how you ran reno report? Did you run it from main without arguments? I am still getting the odd results I saw earlier. Also not entirely sure how to debug what reno is doing.

@taalexander
Copy link
Contributor Author

I just ran it with reno report full output

(qss-compiler) thomas@Thomass-MacBook-Pro openqasm-1 % reno report                            
loaded configuration file ./releasenotes/config.yaml
scanning ./releasenotes/notes (branch=*current* earliest_version=None collapse_pre_releases=True)
including entire branch history
78194cf9de8ded3e: update to releasenotes/notes/add-releasenote-checks-78194cf9de8ded3e.yaml in commit b'c44c713ed42eafbd7d9d87340ec41891113cbc37'
78194cf9de8ded3e: adding releasenotes/notes/add-releasenote-checks-78194cf9de8ded3e.yaml from 3.0-225
78194cf9de8ded3e: copying data for releasenotes/notes/add-releasenote-checks-78194cf9de8ded3e.yaml from commit b'c44c713ed42eafbd7d9d87340ec41891113cbc37'
f720f21a3d792c70: adding releasenotes/notes/clarify-physical-qubits-f720f21a3d792c70.yaml from 3.0-225
2efa545932ed7736: adding releasenotes/notes/drop-dollar-from-pulse-wildcard-2efa545932ed7736.yaml from 3.0-225
001094 b'7fbea5f0a7e43f1b46b2c739b700c3b9d56c5146' updating current version to 3.0
=============
Release Notes
=============

.. _Release Notes_3.0-225:

3.0-225
=======

.. _Release Notes_3.0-225_New Features:

New Features
------------

.. releasenotes/notes/add-releasenote-checks-78194cf9de8ded3e.yaml @ b'c44c713ed42eafbd7d9d87340ec41891113cbc37'

- Added CI support for ensuring contributions include a release note.
  If this is not desired for a PR the tag "no-reno" may be added to the
  PR.


.. _Release Notes_3.0-225_Upgrade Notes:

Upgrade Notes
-------------

.. releasenotes/notes/clarify-physical-qubits-f720f21a3d792c70.yaml @ b'782c3b6986e5ff46757a8867c39bf6f9acac603b'

- Improve physical qubit documentation. Define what constitutes a valid
  physical identifier, define physical circuits, and answer several questions
  about what a compiler may do with physical qubits.

.. releasenotes/notes/drop-dollar-from-pulse-wildcard-2efa545932ed7736.yaml @ b'ce7548adcf1b34941df112f8ecb1194726fd9acd'

- The "wildcard" identifiers in pulse grammars are now regular OpenQASM 3
  identifiers, without the leading dollar sign (``$``), *e.g.* what was ``$q``
  before is now simply ``q``.  Precise hardware qubits are still referenced
  as ``$0``, for example.  This was made for better consistency in identifiers;
  having the dollar sign in the wildcard carried no information, since it
  applied to any qubit already.

@taalexander
Copy link
Contributor Author

I'll need another approving review to merge it seems.

@braised-babbage
Copy link
Contributor

Looks good to me.

I suggested a few things that seemed like small improvements to me.

When I run reno report it generates a report for ast-py/v0.5.0-19 which is rather odd. Partially this is because of the old tag names in the repository, but I'm not sure what the -19 is about. Can we do anything about this in this PR? Or do we just need to fix things when we sort out the release process itself?

I saw this as well. Just tinkering with things, I noticed that when I added a commit, the number got incremented. When I added a dummy ast-py/v0.5.1 tag, the report used this without any suffix. So my guess is that reno report will include notes that have occurred since the last tagged release, indicating the number of commits since then. The recent release notes were added after the ast-py/v0.5.0 release.

Copy link
Contributor

@braised-babbage braised-babbage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for adding this.

@taalexander taalexander merged commit 071bef1 into openqasm:main Jan 17, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add release notes to the openQASM Project
3 participants