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

ci: add workflow to check bindings are up to date #243

Merged
merged 20 commits into from
Jan 21, 2025
Merged

Conversation

ricomateo
Copy link
Contributor

@ricomateo ricomateo commented Jan 21, 2025

Fixes #207

What Changed?

This PR introduces the following changes

  • Adds a CI workflow to check if the bindings are up to date. This works by re-generating the bindings and checking the diff against the existing bindings.
  • Changes the make bindings target to generate the bindings using a specific Foundry version. This is important since different Foundry versions may generate slightly different bindings, which will cause the CI to fail. To ensure a specific Foundry version is used, we run the command inside a Docker container that runs a pinned Foundry version (v0.3.0).
  • Updates the bindings by generating them with the modified make bindings target.

Note: the existing bindings target was renamed to bindings_host, as it runs without Docker. However the bindings_host target is only for CI use only. To generate the bindings, please use the bindings target.

Reviewer Checklist

  • New features are tested and documented
  • PR has one of the changelog-X labels (if applies)
  • Code deprecates any old functionality before removing it

@ricomateo ricomateo marked this pull request as ready for review January 21, 2025 19:03
@ricomateo ricomateo added the pipelines This PR/issue is exclusively about improving our CI label Jan 21, 2025
Co-authored-by: Pablo Deymonnaz <[email protected]>
@ricomateo ricomateo merged commit 1a66fc2 into main Jan 21, 2025
6 checks passed
@ricomateo ricomateo deleted the ci-check-bindings branch January 21, 2025 19:54
MegaRedHand pushed a commit that referenced this pull request Feb 4, 2025
Fixes #207

This PR introduces the following changes
* Adds a CI workflow to check if the bindings are up to date. This works
by re-generating the bindings and checking the diff against the existing
bindings.
* Changes the `make bindings` target to generate the bindings using a
specific Foundry version. This is important since different Foundry
versions may generate slightly different bindings, which will cause the
CI to fail. To ensure a specific Foundry version is used, we run the
command inside a Docker container that runs a pinned Foundry version
(v0.3.0).
* Updates the bindings by generating them with the modified `make
bindings` target.

**Note:** the existing `bindings` target was renamed to `bindings_host`,
as it runs without Docker. However the `bindings_host` target is only
for CI use only. To generate the bindings, please use the `bindings`
target.

- [ ] New features are tested and documented
- [ ] PR has one of the `changelog-X` labels (if applies)
- [ ] Code deprecates any old functionality before removing it

---------

Co-authored-by: Pablo Deymonnaz <[email protected]>
@github-actions github-actions bot mentioned this pull request Feb 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
pipelines This PR/issue is exclusively about improving our CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add workflow that makes sure the bindings are up to date
2 participants