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

Run cargo build and test built binary to ensure it works #235

Closed
Tracked by #225
obi1kenobi opened this issue Dec 19, 2022 · 0 comments · Fixed by #246
Closed
Tracked by #225

Run cargo build and test built binary to ensure it works #235

obi1kenobi opened this issue Dec 19, 2022 · 0 comments · Fixed by #246
Assignees
Labels
C-enhancement Category: raise the bar on expectations

Comments

@obi1kenobi
Copy link
Owner

obi1kenobi commented Dec 19, 2022

I found it this by accident while testing something else with the locally-built binary for the newest version, so we got lucky. Otherwise, I think this would have made it through our entire release process and would have broken our users.

It's probably a good idea to add a CI check that does cargo build, then does a cd into the release directory and runs the built binary directly on some rustdoc JSON files (e.g. from the test suite). If we put it after the cargo test step then it probably will have minimal cost, since cargo test will already have done almost the entire build.

Originally posted by @obi1kenobi in #234 (comment)

#234 got lucky, and caught and fixed a critical issue that would otherwise have made it through our entire release process without getting caught. Let's amend our test setup to prevent it going forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-enhancement Category: raise the bar on expectations
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants