From b1cb65663fc14136b727129a4ba1fe0b6a36449c Mon Sep 17 00:00:00 2001 From: BD103 <59022059+BD103@users.noreply.github.com> Date: Wed, 4 Dec 2024 09:02:59 -0500 Subject: [PATCH] feat: write documentation for each ci workflow MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Alejandra González --- .github/workflows/clippy_dev.yml | 2 ++ .github/workflows/clippy_mq.yml | 4 ++++ .github/workflows/clippy_pr.yml | 2 ++ .github/workflows/deploy.yml | 5 +++++ .github/workflows/lintcheck.yml | 6 ++++++ .github/workflows/remark.yml | 6 ++++++ 6 files changed, 25 insertions(+) diff --git a/.github/workflows/clippy_dev.yml b/.github/workflows/clippy_dev.yml index d6534fbaff94..772176191869 100644 --- a/.github/workflows/clippy_dev.yml +++ b/.github/workflows/clippy_dev.yml @@ -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 (formatting & updating the lints) and `clippy_dev`'s commands specifically. name: Clippy Dev Test on: diff --git a/.github/workflows/clippy_mq.yml b/.github/workflows/clippy_mq.yml index 07d5a08304e8..56c82b82efa9 100644 --- a/.github/workflows/clippy_mq.yml +++ b/.github/workflows/clippy_mq.yml @@ -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: diff --git a/.github/workflows/clippy_pr.yml b/.github/workflows/clippy_pr.yml index 880ebd6e5d5c..8f77f67d2a99 100644 --- a/.github/workflows/clippy_pr.yml +++ b/.github/workflows/clippy_pr.yml @@ -1,3 +1,5 @@ +# 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: diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index ede19c11257e..6ff491aca64a 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -1,3 +1,8 @@ +# This actions generates the documentation available at +# using [`deploy.sh`] and [Github Pages]. +# +# [`deploy.sh`]: ../deploy.sh +# [Github Pages]: https://pages.github.com name: Deploy on: diff --git a/.github/workflows/lintcheck.yml b/.github/workflows/lintcheck.yml index 70c805903d36..33700922d0b1 100644 --- a/.github/workflows/lintcheck.yml +++ b/.github/workflows/lintcheck.yml @@ -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: diff --git a/.github/workflows/remark.yml b/.github/workflows/remark.yml index 7e7e26818c09..2212e4464205 100644 --- a/.github/workflows/remark.yml +++ b/.github/workflows/remark.yml @@ -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: