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

Reno: only require release notes in changes to source directory #511

Merged

Conversation

braised-babbage
Copy link
Contributor

Summary

In #506 we started using Reno for managing release notes. Along with this is check that notes are provided when there is a git diff. This PR tweaks that to only check for changes to the source directory (i.e. changes to the spec or parser & reference AST). My reasoning is that we do not need to provide release notes for changes to things like GitHub actions, project README, etc, so this check should make an effort to ignore such changes.

Copy link
Contributor

@taalexander taalexander left a comment

Choose a reason for hiding this comment

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

Perhaps we should test this with a trivial update to a file in the source directory?

@braised-babbage
Copy link
Contributor Author

Perhaps we should test this with a trivial update to a file in the source directory?

Ok, I tried it out, and saw the following failure (as expected) https://github.com/openqasm/openqasm/actions/runs/7631739064/job/20790381370. I've reverted the change in my latest commit.

Copy link
Contributor

@taalexander taalexander left a comment

Choose a reason for hiding this comment

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

Thanks Erik!

@jlapeyre
Copy link
Contributor

jlapeyre commented Jan 24, 2024

failing CI for an example of why we need this PR.

@braised-babbage braised-babbage merged commit b3170cd into openqasm:main Jan 24, 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.

None yet

3 participants