ci: add build coverage for examples #1655
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit adds a CI workflow to fmt, lint, and build all of the examples. We just default to the latest stable toolchain. We use a single job instead of multiple jobs because sharing matrices across actions is very ugly.
Also switch to using a stable toolchain.
The folder names of the examples were updated earlier, but I forgot to change the matrix names as well.
we actually already have a ci script that runs for examples. We should add linting and formating to it, since I already changed some of those things because I had it running locally.
When updating our actions I noticed that the set-output command is being deprecated, and apparently has some unfortunate security implications. https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/
The output seems to be working, so this should be fine
otherwise github fails to parse it.
The docker image is now failing to build, and I suspect that it is due to some of my tag finagling. Add more logging to see if I can find the differences between the logged outputs.
I am needlessly complicating my life. I'll follow this PR up with the set-output changes. For now, just add formatting and linting to the examples.
I forgot to actually type "clippy" because I just copied the arguments from the earlier action.
I don't know whether the toolchain action works with multiple toolchains, but we're about to findout.
the toolchain documentation said that it should be installed by default, but their examples show it being explicitly installed, so try explicitly installing it.
Since tha path is specified for this examples, it should be consumed transitively. Manually specifying the version will cause build failures after a version bump.
Also fixes the ci step names.
camshaft
reviewed
Mar 7, 2023
camshaft
approved these changes
Mar 7, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolved issues:
resolves #1639
Description of changes:
Update the current
examplejob in theciworkflow to dynamically update itself. Theenvstep outputs a list of all of the examples, and then we run the example ci job on each one of those.This PR also adds a formatting and linting step that run on the example repos.
The created several lint errors that this PR also addresses.
This PR also removes the version specification of the s2n-rustls crate. Since it is specified by path we would otherwise have a broken example everytime we do a version bump.
This also updates the
ci.ymlfile to use the preferred output setting methodology: https://github.blog/changelog/2022-10-11-github-actions-deprecating-save-state-and-set-output-commands/We'll want to follow-up with the other workflow files, but I was running into weird build failures with the qns docker container, so focusing on one issue at a time.
Call-outs:
I'm not disabling the
-A clippy::derive_partial_eq_without_eqlint because there aren't any API stability concerns about examples.Testing:
The examples workflow should pass.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.