Implementing Cargo Commands in PR

[arapower]

How about running the following cargo commands against all PRs, and if there are problems, they cannot be merged?

• cargo build
• cargo check
• cargo test
• cargo bench
• cargo clippy
• cargo fmt
• cargo fix

Additionally, I want to create pull requests for committing lock files and updating dependencies regularly in GitHub Actions workflow.

• cargo doc
• cargo generate-lockfile
• cargo update

I believe this would improve quality of the project, but would like to hear your thoughts on how far we should go with this.

[Ph0enixKM]

Good idea although how would the cargo fix and cargo fmt be useful in the CI environment? It would probably have to commit the changes that contain fixes, right? Is it a good practice?

[arapower]

It is true that cargo fix and cargo fmt modifications must be run locally to be merged.
But the reason for running it on the CI runner is to prevent merging problems that can be pointed out by cargo fix or cargo fmt.
This is a common approach.

For example

• https://github.com/axodotdev/cargo-dist/blob/fae69688bae719725fc47b7bed4b9038c1be133b/.github/workflows/ci.yml#L35-L44

If you want to notice these problems while working locally, it is a good idea to introduce a tool like the one below.

• Git Hooks https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
• rhysd/cargo-husky https://github.com/rhysd/cargo-husky

[Ph0enixKM]

Okay. I see. We use Husky at work so I’m familiar with these tools. I see the point now. I think that you can create an issue for that 🙌.

[arapower]

I am currently considering the following commands, but would like opinions on what other options would be appropriate.

• cargo build --release --verbose
• cargo check --all-targets
• cargo test --all --verbose
• cargo bench -- --test
• cargo clippy -- -D warnings
• cargo doc --no-deps
• cargo fmt --all -- --check
• cargo fix --allow-dirty --allow-staged
• cargo generate-lockfile

[arapower]

Also, at what timing (trigger) should the following commands be executed to create a PR?

• cargo doc
• cargo generate-lockfile
• cargo update

[Mte90]

Right now we just do test but you can improve the CI

[Ph0enixKM]

I don't want to focus on CI too much just yet until we get to the stable release.