diff --git a/.github/workflows/check-frontend.yml b/.github/workflows/check-frontend.yml index 634ad84ee2..be2c3b0fde 100644 --- a/.github/workflows/check-frontend.yml +++ b/.github/workflows/check-frontend.yml @@ -1,3 +1,7 @@ +# This workflow runs the frontend code quality checks. +# +# It may be triggered via dispatch, or by another workflow. + name: 'Check: frontend' on: diff --git a/.github/workflows/check-pytest.yml b/.github/workflows/check-pytest.yml index bdab6fc4d4..0839c1d5a4 100644 --- a/.github/workflows/check-pytest.yml +++ b/.github/workflows/check-pytest.yml @@ -1,3 +1,7 @@ +# This workflow runs pytest on the codebase in a matrix of platforms. +# +# It may be triggered via dispatch, or by another workflow. + name: 'Check: pytest' on: diff --git a/.github/workflows/check-python.yml b/.github/workflows/check-python.yml index c58b4661c7..c37fb5683c 100644 --- a/.github/workflows/check-python.yml +++ b/.github/workflows/check-python.yml @@ -1,3 +1,9 @@ +# This workflow runs the python code quality checks. +# +# It may be triggered via dispatch, or by another workflow. +# +# TODO: Add mypy or pyright to the checks. + name: 'Check: python' on: diff --git a/.github/workflows/on-change-check-frontend.yml b/.github/workflows/on-change-check-frontend.yml index 814f94ca5b..d134645e86 100644 --- a/.github/workflows/on-change-check-frontend.yml +++ b/.github/workflows/on-change-check-frontend.yml @@ -1,3 +1,8 @@ +# This workflow runs of `check-frontend.yml` on push or pull request. +# +# The actual checks are in a separate workflow to support simpler workflow +# composition without awkward or complicated conditionals. + name: 'On change: run check-frontend' on: diff --git a/.github/workflows/on-change-check-python.yml b/.github/workflows/on-change-check-python.yml index cc2be902b4..a7b56d8b13 100644 --- a/.github/workflows/on-change-check-python.yml +++ b/.github/workflows/on-change-check-python.yml @@ -1,3 +1,8 @@ +# This workflow runs of `check-python.yml` on push or pull request. +# +# The actual checks are in a separate workflow to support simpler workflow +# composition without awkward or complicated conditionals. + name: 'On change: run check-python' on: diff --git a/.github/workflows/on-change-pytest.yml b/.github/workflows/on-change-pytest.yml index 081d85d4fb..6f64ce878b 100644 --- a/.github/workflows/on-change-pytest.yml +++ b/.github/workflows/on-change-pytest.yml @@ -1,3 +1,8 @@ +# This workflow runs of `check-pytest.yml` on push or pull request. +# +# The actual checks are in a separate workflow to support simpler workflow +# composition without awkward or complicated conditionals. + name: 'On change: run pytest' on: