-
Notifications
You must be signed in to change notification settings - Fork 322
Documentation updates #3402
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
Merged
Merged
Documentation updates #3402
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
05b8803
Document checks
danieljurek 6ea37cd
Document versioning strategy in CONTRIBUTING.md
danieljurek 3a0a5c8
Apply suggestions from code review
danieljurek c42e5af
Move checks.md
danieljurek 211c789
Review feedback, drop --target from clippy, we also run it without that
danieljurek 39b024d
Add cargo audit
danieljurek a65a1c9
Remove params
danieljurek 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| # Engineering System checks | ||
|
|
||
| These checks run in addition to logic tests. | ||
|
|
||
| ## Standard checks | ||
|
|
||
| The Engineering System provides a set of [standard checks](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/1215/Source-and-Artifact-scans-and-checks). | ||
|
|
||
| ## Rust-specific checks | ||
|
|
||
| ### Checks included in `cargo` | ||
|
|
||
| The following checks are included in the Rust toolchain or are part of cargo. | ||
|
|
||
| #### Audit | ||
|
|
||
| Documentation: [cargo-audit](https://github.com/rustsec/rustsec/tree/main/cargo-audit) | ||
|
|
||
| Runs in: [Analyze-Code.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Analyze-Code.ps1) | ||
|
|
||
| ``` | ||
| cargo audit | ||
| ``` | ||
|
|
||
| #### Fmt | ||
|
|
||
| Documentation: [cargo-fmt](https://doc.rust-lang.org/cargo/commands/cargo-fmt.html) | ||
|
|
||
| Runs in: [Analyze-Code.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Analyze-Code.ps1) | ||
|
|
||
| ``` | ||
| cargo fmt | ||
| ``` | ||
|
|
||
| #### Clippy | ||
|
|
||
| Documentation: [cargo-clippy](https://doc.rust-lang.org/cargo/commands/cargo-clippy.html) | ||
|
|
||
| Runs in: [Analyze-Code.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Analyze-Code.ps1) | ||
|
|
||
| ``` | ||
| cargo clippy | ||
| ``` | ||
|
|
||
| #### Check | ||
|
|
||
| > [!NOTE] | ||
| > This only runs against `azure-core` and not against other packages in the build | ||
|
|
||
| Documentation: [cargo-check](https://doc.rust-lang.org/cargo/commands/cargo-check.html) | ||
|
|
||
| Runs in: [Analyze-Code.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Analyze-Code.ps1) | ||
|
|
||
| ``` | ||
| cargo check | ||
| ``` | ||
|
|
||
| #### Doc | ||
|
|
||
| Documentation: [cargo-doc](https://doc.rust-lang.org/cargo/commands/cargo-doc.html) | ||
|
|
||
| Runs in: [Analyze-Code.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Analyze-Code.ps1) | ||
|
|
||
| ``` | ||
| cargo doc | ||
| ``` | ||
|
|
||
| #### Docs-rs | ||
|
|
||
| Documentation: [cargo-docs-rs](https://github.com/dtolnay/cargo-docs-rs) | ||
|
|
||
| Runs in: [Analyze-Code.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Analyze-Code.ps1) | ||
|
|
||
| ``` | ||
| cargo install --locked cargo-docs-rs | ||
| cargo +nightly docs-rs | ||
| ``` | ||
|
|
||
| ### Checks installed as tools | ||
|
|
||
| Additional checks can be installed as tools by `cargo install` and run in relevant parts of the build system. | ||
|
|
||
| ### Deny | ||
|
|
||
| Documentation: [cargo-deny](https://github.com/EmbarkStudios/cargo-deny) | ||
|
|
||
| Runs in [Analyze-Code.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Analyze-Code.ps1) | ||
|
|
||
| ``` | ||
| cargo install cargo-deny | ||
| cargo deny | ||
| ``` | ||
|
|
||
| ### Semver | ||
|
|
||
| Documentation: [cargo-semver-checks](https://github.com/obi1kenobi/cargo-semver-checks) | ||
|
|
||
| Runs in [Test-Semver.ps1](https://github.com/Azure/azure-sdk-for-rust/blob/main/eng/scripts/Test-Semver.ps1) | ||
|
|
||
| ``` | ||
| cargo install cargo-semver-checks | ||
| cargo semver-checks | ||
| ``` |
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.