diff options
| author | flip1995 <philipp.krones@embecosm.com> | 2022-04-17 16:19:00 +0200 |
|---|---|---|
| committer | Philipp Krones <hello@philkrones.com> | 2022-06-06 16:17:57 +0200 |
| commit | cbe4de2f6c7a3acad88a0eeb5bce1a97419da0ff (patch) | |
| tree | 58c1683e8cf11bd7027709c3385edb25c84ba879 | |
| parent | 6b21d386f66cfd574bf8e65769fd41231e592ad8 (diff) | |
| download | rust-cbe4de2f6c7a3acad88a0eeb5bce1a97419da0ff.tar.gz rust-cbe4de2f6c7a3acad88a0eeb5bce1a97419da0ff.zip | |
Book: Add continuous integration description
| -rw-r--r-- | book/src/SUMMARY.md | 2 | ||||
| -rw-r--r-- | book/src/continuous_integration/README.md | 16 |
2 files changed, 17 insertions, 1 deletions
diff --git a/book/src/SUMMARY.md b/book/src/SUMMARY.md index 16e9bea1bdc..0b945faf9b7 100644 --- a/book/src/SUMMARY.md +++ b/book/src/SUMMARY.md @@ -7,8 +7,8 @@ - [Configuration](configuration.md) - [Clippy's Lints](lints.md) - [Continuous Integration](continuous_integration/README.md) - - [Travis CI](continuous_integration/travis.md) - [GitHub Actions](continuous_integration/github_actions.md) + - [Travis CI](continuous_integration/travis.md) - [Development](development/README.md) - [Basics](development/basics.md) - [Adding Lints](development/adding_lints.md) diff --git a/book/src/continuous_integration/README.md b/book/src/continuous_integration/README.md index 257fa0f8df4..9f1374193de 100644 --- a/book/src/continuous_integration/README.md +++ b/book/src/continuous_integration/README.md @@ -1 +1,17 @@ # Continuous Integration + +It is recommended to run Clippy on CI, preferably with `-Dwarnings`, so that +Clippy lints prevent CI from passing. + +We recommend to use Clippy from the same toolchain, that you use for compiling +your crate for maximum compatibility. E.g. if your crate is compiled with the +`stable` toolchain, you should also use `stable` Clippy. + +> _Note:_ New Clippy lints are first added to the `nightly` toolchain. If you +> want to help with improving Clippy and have CI resources left, please consider +> adding a `nightly` Clippy check to your CI and report problems like false +> positives back to us. With that we can fix bugs early, before they can get to +> stable. + +This chapter will give an overview on how to use Clippy on different popular CI +providers. |