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

Write documentation for each CI workflow #13778

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/clippy_dev.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 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.
Comment on lines +1 to +2
Copy link
Member

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.

Suggested change
# 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.

name: Clippy Dev Test

on:
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/clippy_mq.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
# This action runs Clippy's test suite, as well as a few larger and more in-depth tests to verify
# that the pull request is ready to be merged. (This action is run as part of the [merge queue].)
#
# [merge queue]: https://github.com/rust-lang/rust-clippy/queue/
name: Clippy Test (merge queue)

on:
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/clippy_pr.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# This action runs Clippy's test suite for all of its crates.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# 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.

name: Clippy Test

on:
Expand Down
5 changes: 5 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
# This actions generates the documentation available at <https://rust-lang.github.io/rust-clippy>
# using [`deploy.sh`] and [Github Pages].
#
# [`deploy.sh`]: ../deploy.sh
# [Github Pages]: https://pages.github.com
name: Deploy

on:
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/lintcheck.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# This action runs [Lintcheck] on on the current pull request and its target branch (which is
# usually `master`), and compares the results. If they are different, a [job summary] is created
# with the changes.
#
# [Lintcheck]: ../../lintcheck
# [job summary]: https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/workflow-commands-for-github-actions#adding-a-job-summary
name: Lintcheck

on: pull_request
Expand Down
6 changes: 6 additions & 0 deletions .github/workflows/remark.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
# This action uses [Remark] to lint all the Markdown files in this repository. It also runs
# [Linkchecker], which is used to validate links within the Clippy Book. (Not to be confused with
# Lintcheck, which checks lints!)
#
# [Remark]: https://www.npmjs.com/package/remark
# [Linkchecker]: https://github.com/rust-lang/rust/tree/master/src/tools/linkchecker
name: Remark

on:
Expand Down
Loading