Add unstable feature and improve CI for feature flags #590
Conversation
nicholasbishop force-pushed the bishop-add-unstable-feat branch from e6572d0 to e07bf5e Compare nicholasbishop force-pushed the bishop-add-unstable-feat branch from e07bf5e to 527cd72 Compare 
| //! - `unstable`: Enable functionality that depends on [unstable | ||
| //! features] in the nightly compiler. Note that currently the `uefi` | ||
| //! crate _always_ requires unstable features even if the `unstable` | ||
| //! feature is not enabled, but once a couple more required features |
There was a problem hiding this comment.
nit: there is a small risk that we may not update this comment here when uefi works on stable eventually.
The unstable feature will be used to gate the use of new unstable features. We hope to make the uefi crate work on the stable channel once the `abi_efiapi` and `default_alloc_error_handler` features are stabilized, so we don't want to start relying unconditionally on new unstable features. For now the new feature just gates `error_in_core`, but some additional features will be gated here soon.
The `--feature-permutations` flag runs a bunch of builds of just the `uefi` and `uefi-services` crates to test that the build works no matter what features are selected.
| - name: Build | ||
| run: cargo xtask build | ||
| | ||
| build_feature_permutations: |
There was a problem hiding this comment.
Unfortunately, this will increase our CI times :/
But for what it's worth, this is a good thing to have, I think
There was a problem hiding this comment.
It might not increase the time actually since the jobs are run in parallel. The times vary from one run to another, but for example in https://github.com/rust-osdev/uefi-rs/actions/runs/3557618653/ the new job took 3m26s, but the aarch64 job took 3m39s, the lint job took 3m40s, and the Windows job took 3m50s. So CI times seem likely to remain about the same as before.
There was a problem hiding this comment.
Okay, then forget what I've said. Probably, it is not a big problem then :)
phip1611 force-pushed the bishop-add-unstable-feat branch from 527cd72 to 87df1a5 Compare 2 participants
Note: the first commit in this PR is from #589 so that we don't have to resolve merge conflicts later.
This PR adds an
unstablefeature to the uefi crate. It will be used to gate new unstable features as we work towards being able to compile on the stable channel. Re naming, bothnightlyandunstableare used frequently by other crates.nightlyis slightly more common, but I thinkunstableis more accurate since unstable features can be enabled on non-nightly builds of the compiler, and the documentation for these features is the Unstable Book, as opposed to the "Nightly Book".Also in this PR is a new build mode:
cargo xtask build --feature-permutations. This builds bothuefianduefi-servicesa bunch of times with different feature flags set, to make sure that compilation still works in all cases. There's a new CI job to run this command as well.Checklist