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.

Sign up for GitHub

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 action to upload a patch when bindings differ #1958

Merged
merged 10 commits into from
Dec 19, 2024
Merged

add action to upload a patch when bindings differ #1958

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
1b6564d
add action to upload a patch when bindings differ
Geometer1729 Dec 18, 2024
dacd84c
add dummy file to bindings to test ci
Geometer1729 Dec 18, 2024
6be1480
bindings diff that will actually trip ci
Geometer1729 Dec 18, 2024
9b04ffa
fix bindings ref
Geometer1729 Dec 18, 2024
7e99bba
change path for patch and apply patch from github
Geometer1729 Dec 18, 2024
8fa9a04
revert bindings to make sure new path works
Geometer1729 Dec 18, 2024
d6e52c1
restore bindings
Geometer1729 Dec 18, 2024
03595d4
just point bindings at main
Geometer1729 Dec 18, 2024
3d2854a
add documentation for bindings patch (and break bindings)
Geometer1729 Dec 19, 2024
19886d8
fix link and restore bindings
Geometer1729 Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions .github/workflows/build-bindings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ jobs:
nix run o1js#update-bindings --max-jobs 4
#fail if this changes any files
cd src/bindings
echo If this check fails you can download a patch from the patch-upload job
echo "https://github.com/o1-labs/o1js/blob/main/README-dev.md#bindings-check-in-ci"
git diff --exit-code
- name: add build to gc-root if on main
if: github.ref == 'refs/heads/main'
Expand All @@ -39,3 +41,18 @@ jobs:
run: |
nix-store --gc --print-dead
nix-store --optimise
patch-upload:
needs: nix-build
if: ${{ failure() }}
runs-on: [sdk-self-hosted-linux-amd64-build-system]
steps:
- name: generate patch
run: |
cd src/bindings
git add .
git diff HEAD > ../../bindings.patch
- name: Upload patch
uses: actions/upload-artifact@v4
with:
name: bindings.patch
path: bindings.patch
14 changes: 14 additions & 0 deletions README-dev.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,20 @@ In addition to building the OCaml and Rust code, the build script also generates

o1js uses these types to ensure that the constants used in the protocol are consistent with the OCaml source files.

### Bindings check in ci

If the bindings check fails in CI it will upload a patch you can use to update the bindings without having to rebuild locally.
This can also be helpful when the bindings don't build identically, as unfortunately often happens.

To use this patch:
- Click details on the `Build o1js bindings / build-bindings-ubunutu` job
- Go to the `patch-upload` job and expand the logs for `Upload patch`
- Download the file linked in the last line of the logs ie.
`Artifact download URL: https://github.com/o1-labs/o1js/actions/runs/12401083741/artifacts/2339952965`
- unzip it
- navigate to `src/bindings`
- run `git apply path/to/bindings.patch`

## Development

### Branching Policy
Expand Down
Loading