-
Notifications
You must be signed in to change notification settings - Fork 2.9k
feat(compile): Stabilize build.warnings
#16796
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
Open
epage
wants to merge
1
commit into
rust-lang:master
Choose a base branch
from
epage:warning
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 file contains hidden or 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 file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -204,7 +204,34 @@ This tries to balance thoroughness with turnaround time: | |
| - `cargo check` is used as most issues contributors will run into are API availability and not behavior. | ||
| - Unpublished packages are skipped as this assumes only consumers of the verified project, through a registry, will care about `rust-version`. | ||
|
|
||
| ## Checking for warnings | ||
|
|
||
| Customarily, projects want to be "warnings clean" on official branches while being lax for local development. | ||
| [`build.warnings = "deny"`] can be used to fail a CI job if warnings are present. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Not a blocker: would love to see we discourage |
||
|
|
||
| An example CI job to check for warnings using GitHub Actions: | ||
| ```yaml | ||
| jobs: | ||
| warnings: | ||
| runs-on: ubuntu-latest | ||
| env: | ||
| CARGO_BUILD_WARNINGS: deny | ||
| steps: | ||
| - uses: actions/checkout@v4 | ||
|
weihanglo marked this conversation as resolved.
|
||
| - run: rustup update stable && rustup default stable | ||
| - run: rustup component add clippy | ||
| - run: cargo clippy --all-targets --all-features --keep-going | ||
| ``` | ||
|
|
||
| Considerations: | ||
| - CI can fail due to new toolchain versions because there are limited compatibility guarantees around warnings. | ||
| Consider pinning the toolchain version with an automated job that creates a PR to upgrade the toolchain on new releases. | ||
| - Balance between exhaustiveness and turnaround time in selecting the combinations of platforms, features, and package/build-target combinations to check | ||
| - Some CI systems have direct integration for reporting lints, e.g. using [`clippy-sarif`] with GitHub | ||
|
|
||
| [`build.warnings = "deny"`]: ../reference/config.md#buildwarnings | ||
| [`cargo add`]: ../commands/cargo-add.md | ||
| [`cargo install`]: ../commands/cargo-install.md | ||
| [`clippy-sarif`]: https://crates.io/crates/clippy-sarif | ||
| [Dependabot]: https://docs.github.com/en/code-security/dependabot/working-with-dependabot | ||
| [RenovateBot]: https://renovatebot.com/ | ||
This file contains hidden or 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 file contains hidden or 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.