mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Book: Add continuous integration description

Browse Source
This commit is contained in:
flip1995 2022-04-17 16:19:00 +02:00 committed by Philipp Krones
parent 6b21d386f6
commit cbe4de2f6c
No known key found for this signature in database
GPG Key ID: 1CA0DF2AF59D68A5
2 changed files with 17 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
book/src/SUMMARY.md
View File

@ -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)

16
book/src/continuous_integration/README.md
View File

@ -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.