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 wasm-bindgen version check to CI #7983

Merged
merged 10 commits into from
Nov 4, 2024
Merged

Add wasm-bindgen version check to CI #7983

merged 10 commits into from
Nov 4, 2024

Conversation

jprochazk
Copy link
Member

@jprochazk jprochazk commented Nov 4, 2024

What

  • Remove stored hashes and hash checks in JS package
  • Add check for changes to wasm-bindgen version in CI

I believe our web viewer was broken since this PR:

There were multiple people reviewing it (including myself with a "Web stuff LGTM" 🤦 ), and yet none of us remembered to check the output of wasm-bindgen. We clearly need something to remind us.

The new CI check added in this PR will compare the wasm-bindgen version to the one on main, and require the wasm-bindgen version update label if they differ. This is vastly better than committing and comparing hashes of the built files, because:

  1. It's significantly faster on CI (doesn't require both release and debug Wasm builds)
  2. It doesn't trigger when the hash of the output changes for reasons other than the version of wasm-bindgen changing

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!
  • If have noted any breaking changes to the log API in CHANGELOG.md and the migration guide

To run all checks from main, comment on the PR with @rerun-bot full-check.

@jprochazk jprochazk added dependencies concerning crates, pip packages etc include in changelog 🚢 CI labels Nov 4, 2024
@jprochazk jprochazk added the wasm-bindgen version update Version of `wasm-bindgen` changed. Our JS package is highly sensitive to its output! label Nov 4, 2024
@jprochazk jprochazk removed the wasm-bindgen version update Version of `wasm-bindgen` changed. Our JS package is highly sensitive to its output! label Nov 4, 2024
@jprochazk jprochazk added the wasm-bindgen version update Version of `wasm-bindgen` changed. Our JS package is highly sensitive to its output! label Nov 4, 2024
@jprochazk jprochazk removed the wasm-bindgen version update Version of `wasm-bindgen` changed. Our JS package is highly sensitive to its output! label Nov 4, 2024
@jprochazk jprochazk added the wasm-bindgen version update Version of `wasm-bindgen` changed. Our JS package is highly sensitive to its output! label Nov 4, 2024
@jprochazk jprochazk merged commit 28396f7 into main Nov 4, 2024
32 checks passed
@jprochazk jprochazk deleted the jan/wasm-bindgen-check branch November 4, 2024 10:13
jprochazk added a commit that referenced this pull request Nov 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies concerning crates, pip packages etc include in changelog 🚢 CI wasm-bindgen version update Version of `wasm-bindgen` changed. Our JS package is highly sensitive to its output!
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant