Codify linting toolchain #1251
Merged
Codify linting toolchain #1251
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
Moves the nightly toolchain we use for linting out of a GitHub action and into a dedicated `rust-toolchain.lint.toml` file. rustup doesn't currently support specifying a toolchain file, though [it will soon](rust-lang/rustup#2686), so we hack around it by moving the toolchain file back and forth as part of the GitHub action for Rust.
ma2bd
added a commit
to ma2bd/linera-protocol
that referenced
this pull request
Nov 20, 2023
This reverts commit 7ec6f67.
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.
Motivation
It is unfortunate that our linting toolchain is only specified in the GitHub actions, as this requires local developers to keep their local nightly updated to match that file.
Proposal
This PR moves the specification of our linting toolchain out of the GitHub actions into a dedicated toolchain file. Different toolchains are stored in
toolchains/{name}/rust-toolchain.toml, which should make it possible to select between them in CI by running the action from that directory. Eventually this will no longer be necessary, asrustupis planning to add support for multiple toolchain files.We also add a new
devShellto the Nix flake that references the linting toolchain file, allowingnix develop .#lintto drop the developer into a shell suitable for running our CI lints.Test Plan
CI.
Release Plan
These changes should be invisible to the user.
Links
rust-toolchain.toml" rust-lang/rustup#2686 will allow us to simplify the toolchain structure, as well as add arustup ensurecommand to replace the (deprecated) behaviour ofrustup showthat is currently relied upon by the action.