diff --git a/.github/workflows/deploy-docs.yaml b/.github/workflows/deploy-docs.yaml index 659cdb6..5f4b13a 100644 --- a/.github/workflows/deploy-docs.yaml +++ b/.github/workflows/deploy-docs.yaml @@ -1,7 +1,7 @@ -# -------------------------------------------------------- -# This workflow will lint each PR and commit. -# rebase their PR by commenting '/rebase' on their PR. -# -------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- +# This workflow deploys the documentation site on GitHub Pages. +# The site is accessible on https://{{repo_owner}}.github.io/{{repo_name}} +# ------------------------------------------------------------------------------------------------- --- name: deploy-docs diff --git a/.github/workflows/issue-voting.yaml b/.github/workflows/issue-voting.yaml index 401dc97..4c3add7 100644 --- a/.github/workflows/issue-voting.yaml +++ b/.github/workflows/issue-voting.yaml @@ -1,7 +1,7 @@ -# -------------------------------------------------------- -# This workflow comments on each new issue with a message -# explaining how to vote on the issue. -# -------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- +# This workflow comments on each new issue with a message explaining how to behave and vote on +# the issue. +# ------------------------------------------------------------------------------------------------- --- name: issue-voting diff --git a/.github/workflows/leaked-secrets.yaml b/.github/workflows/leaked-secrets.yaml index 5c6bfd3..b29bc18 100644 --- a/.github/workflows/leaked-secrets.yaml +++ b/.github/workflows/leaked-secrets.yaml @@ -1,6 +1,6 @@ -# -------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- # This workflow checks for leaked credentials -# -------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- --- name: leaked-secrets diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index 81cbd32..e520854 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -1,7 +1,6 @@ -# -------------------------------------------------------- -# This workflow will lint each PR and commit. -# rebase their PR by commenting '/rebase' on their PR. -# -------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- +# This workflow lints the codebase. +# ------------------------------------------------------------------------------------------------- --- name: lint diff --git a/.github/workflows/pr-helper.yaml b/.github/workflows/pr-helper.yaml index 0962647..fecac99 100644 --- a/.github/workflows/pr-helper.yaml +++ b/.github/workflows/pr-helper.yaml @@ -1,7 +1,6 @@ -# -------------------------------------------------------- -# This workflow comments on each new issue with a message -# explaining how to vote on the issue. -# -------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- +# This workflow comments on each new PR with a link to explain the PR process. +# ------------------------------------------------------------------------------------------------- --- name: pr-helper diff --git a/.github/workflows/rebase.yaml b/.github/workflows/rebase.yaml index 58458a0..5c63b1e 100644 --- a/.github/workflows/rebase.yaml +++ b/.github/workflows/rebase.yaml @@ -1,7 +1,6 @@ -# -------------------------------------------------------- -# This workflow allows users of this repo to automatically -# rebase their PR by commenting '/rebase' on their PR. -# -------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- +# This workflow allows users of this repo to automatically rebase their PR. +# ------------------------------------------------------------------------------------------------- --- name: rebase diff --git a/.github/workflows/stale.yaml b/.github/workflows/stale.yaml index 0e1cdea..fc62d85 100644 --- a/.github/workflows/stale.yaml +++ b/.github/workflows/stale.yaml @@ -1,11 +1,11 @@ -# ---------------------------------------------------------------------------- -# This workflow checks periodically for issues and pull requests which had no -# activity in a while and marks them as stale before eventually deleting them. -# To make the most of it, you should make use of the following labels: +# ------------------------------------------------------------------------------------------------- +# This workflow checks periodically for issues and pull requests which had no activity in a while +# and marks them as stale before eventually deleting them. +# To make the most of it, you should mark issues and PRs with the following labels: # - high-priority # - medium-priority # - low-priority -# ---------------------------------------------------------------------------- +# ------------------------------------------------------------------------------------------------- --- name: stale