-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Write documentation for each CI workflow #13778
base: master
Are you sure you want to change the base?
Conversation
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @blyxyas (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the documentation changes! Just a couple nits and this should be merged. ❤️
# This action runs tests specific to `clippy_dev`, accessing through the `cargo dev` command. It | ||
# both checks the project as a whole and tests `clippy_dev`'s commands specifically. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it would be great if we specified which steps are taking for checking the project as a whole.
# This action runs tests specific to `clippy_dev`, accessing through the `cargo dev` command. It | |
# both checks the project as a whole and tests `clippy_dev`'s commands specifically. | |
# This action runs tests specific to `clippy_dev`, accessing through the `cargo dev` command. It | |
# both checks the project as a whole (formatting & updating the lints) and `clippy_dev`'s commands specifically. |
@@ -1,3 +1,4 @@ | |||
# This action runs Clippy's test suite for all of its crates. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# This action runs Clippy's test suite for all of its crates. | |
# This action runs Clippy's test suite on the pull request patch. | |
# Making sure that a pull request doesn't break anything. |
Usually it's @flip1995 the go-to person for CI changes, so he could give better advice than me, but let me know if you're stuck at any point in the process! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hmm, I would prefer to write documentation about the CI setup in the book. This is also one of my forever TODOs...
Maybe this gives me the necessary motivation to do this over the weekend. If not, we can merge this.
@flip1995 would you like me to move the notes into the Clippy book instead? If you tell me where you want it, I can easily move it over. :) |
Nah the notes are not extensive enough to paint the full picture of how our CI setup works and why each workflow exists. I really need to write down the status quo of CI. I had to take a break from my computer this weekend though... |
While I was working on #13033, I noticed that the workflows in CI are a bit difficult to understand for beginners. To amend this, I added short descriptions to the beginning of all actions in
.github/workflows
summarizing what they do.r? @blyxyas
(I'm requesting your review because it's related to #13033, and I also don't know anyone else who's familiar with the CI in this project. Please point me in the right direction if there's someone better suited for this PR!)