search

polyphony-chat / chorus

A Rust library for interacting with multiple Polyphony- and Spacebar-Compatible instances at once.
https://crates.io/crates/chorus
Mozilla Public License 2.0
16 stars 7 forks source link

CI/CD: add cargo-doc job #544

Closed kozabrada123 closed 1 month ago

kozabrada123 commented 1 month ago

Adds a cargo doc job to add rustdoc lints to code scanning, similar to clippy.

Note: under the hood, I literally used clippy-sarif; I haven't been able to find an equivalent for rustdoc, but it seems to work well

github-advanced-security[bot] commented 1 month ago

This pull request sets up GitHub code scanning for this repository. Once the scans have completed and the checks have passed, the analysis results for this pull request branch will appear on this overview. Once you merge this pull request, the 'Security' tab will show more code scanning analysis results (for example, for the default branch). Depending on your configuration and choice of analysis tool, future pull requests will be annotated with code scanning analysis results. For more information about GitHub code scanning, check out the documentation.

kozabrada123 commented 1 month ago

To see how the lints would look

kozabrada123 commented 1 month ago

Can I ask what you think @bitfl0wer? Is this worth adding or is it too dumb

bitfl0wer commented 1 month ago

I think this is a good addition, especially with the configuration of only running on PRs to main and dev.