Skip to content
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

Add additional CI checks #182

Merged
merged 3 commits into from
Mar 29, 2024
Merged

Add additional CI checks #182

merged 3 commits into from
Mar 29, 2024

Conversation

prokopyl
Copy link
Member

This PR adds a variety of checks to the CI:

  • Check that all code and examples build without warnings using -D warnings. This is done for all platforms, with or without the OpenGL feature.
  • Check that all documentation is valid, and that no documentation links are broken, using cargo doc with -D warnings.
  • Run clippy with -D warnings (but otherwise only the default lints).
  • Check formatting using rustfmt.

This PR also applies some light formatting and code fixes that were detected by rustfmt and clippy.

This also makes some updates to the actions used:

  • Update actions/checkout to v4
  • Replace actions-rs/toolchain (which is not maintained anymore) to dtolnay/rust-toolchain instead

Some further work that is not covered by this PR:

  • The missing-safety-doc lint has been temporarily disabled. This will be re-enabled in another PR that will add the proper safety docs to the affected functions.
  • cargo-deny has been discussed, but I prefer adding it in a later PR as it can be its own can of worms regarding licenses and dependencies.

.github/workflows/rust.yml Outdated Show resolved Hide resolved
@prokopyl prokopyl requested a review from glowcoil March 29, 2024 04:56
.github/workflows/rust.yml Outdated Show resolved Hide resolved
@prokopyl prokopyl requested a review from glowcoil March 29, 2024 05:08
Add clippy, rustdoc and rustfmt to CI
Replace obsolete actions-rs
@prokopyl prokopyl merged commit 119fc25 into RustAudio:master Mar 29, 2024
3 checks passed
@prokopyl prokopyl deleted the ci-checks branch March 29, 2024 23:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants