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

feat: Rust semver-checks workflow against base branch #13

Merged
merged 6 commits into from
Oct 21, 2024

Conversation

aborgna-q
Copy link
Collaborator

@aborgna-q aborgna-q commented Oct 18, 2024

Test PR: CQCL/hugr#1598

Limitations:

  • Comments won't be updated when the PR title is changed (added/removed a ! flag).
    It will only change when a new commit is pushed.

@aborgna-q aborgna-q force-pushed the ab/semver-checks branch 5 times, most recently from 13ede8f to 1b4d6fb Compare October 18, 2024 15:16
@aborgna-q
Copy link
Collaborator Author

It should be working now!

- uses: actions/checkout@v4
with:
path: PR_BRANCH
- name: Checkout baseline
Copy link
Member

Choose a reason for hiding this comment

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

Seems the most useful is to be able to test against the last tagged commit (possibly with the tag matching some pattern), is that possible?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That's the default behaviour, and it's actually what semver-checks-action does.
The problem is that the output is not really useful for the PR author, as once a breaking change gets merged will reappear as noise on every subsequent PR.
We'll still get the aggregated comparison against the last release on the release-plz PR, so no need to repeat it here.

s-c-action plans to add the baseline checks at some point, but it requires some changes to its definition first.
See the discussion in obi1kenobi/cargo-semver-checks-action#64
For now the alternative is to manually run semver-checks, as we do here.

Copy link
Member

Choose a reason for hiding this comment

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

Got it, I agree that release-plz is handling my problem

.github/workflows/rs-semver-checks.yml Show resolved Hide resolved
@aborgna-q aborgna-q changed the title feat: Rust semver-checks workflow feat: Rust semver-checks workflow against base branch. Oct 21, 2024
@aborgna-q aborgna-q changed the title feat: Rust semver-checks workflow against base branch. feat: Rust semver-checks workflow against base branch Oct 21, 2024
Copy link
Member

@ss2165 ss2165 left a comment

Choose a reason for hiding this comment

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

🚀

@aborgna-q aborgna-q added this pull request to the merge queue Oct 21, 2024
Merged via the queue into main with commit aa6302b Oct 21, 2024
3 checks passed
@aborgna-q aborgna-q deleted the ab/semver-checks branch October 21, 2024 10:31
github-merge-queue bot pushed a commit to CQCL/hugr that referenced this pull request Oct 21, 2024
Run `cargo-ci-checks` on each PR, and add a comment with the output if
there are breaking changes.
See CQCL/hugrverse-actions#13

drive-by: Allow forcing the checks to run by adding a `run-ci-checks`
label to the PR. Imported from tket2.

https://github.com/CQCL/tket2/blob/740b3ec20f7d3889162c935a47cd0de9ba250a45/.github/workflows/ci.yml#L44

<img width="894" alt="image"
src="https://github.com/user-attachments/assets/10748599-e2ab-46fa-979f-d8246c203d5a">
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.

2 participants