diff --git a/.github/workflows/i18n-completeness.yml b/.github/workflows/i18n-completeness.yml index 28ebd8eda..7a827c9d0 100644 --- a/.github/workflows/i18n-completeness.yml +++ b/.github/workflows/i18n-completeness.yml @@ -1,15 +1,15 @@ -# Installed as .github/workflows/i18n-completeness.yml in each repo that holds -# English. Copy it byte for byte from exercism/i18n/source-repo-workflows/. -# Keep the filename, because exercism/i18n's rerun-source-check.yml finds this -# workflow's runs by it. +# This workflow is installed as .github/workflows/i18n-completeness.yml in +# every repo that holds English. Don't edit it in those repos. Edit it in +# exercism/i18n/source-repo-workflows/ and copy it to each repo. Keep the file +# name, because exercism/i18n's rerun-source-check.yml looks for it. # -# The check fails while exercism/i18n is missing a translation of English that -# the PR changes. The logic lives in -# exercism/i18n/.github/workflows/source-completeness.yml, which explains how -# it reads the PR without checking it out. This file holds only the trigger and -# the permissions. +# This workflow checks that exercism/i18n has a translation of all the English +# a PR changes, and fails if anything is missing. The work happens in +# exercism/i18n/.github/workflows/source-completeness.yml. This file only sets +# when it runs and what it is allowed to do. # -# The status context is `i18n / completeness`, the name to require on `main`. +# GitHub reports this check as `i18n / completeness`. To make it a required +# check, require that name. name: i18n completeness diff --git a/.github/workflows/i18n-queue.yml b/.github/workflows/i18n-queue.yml index 9e0aa5be3..0a54a99b8 100644 --- a/.github/workflows/i18n-queue.yml +++ b/.github/workflows/i18n-queue.yml @@ -1,17 +1,17 @@ -# Installed as .github/workflows/i18n-queue.yml in each repo that holds -# English. Copy it byte for byte from exercism/i18n/source-repo-workflows/. +# This workflow is installed as .github/workflows/i18n-queue.yml in every repo +# that holds English. Don't edit it in those repos. Edit it in +# exercism/i18n/source-repo-workflows/ and copy it to each repo. # -# When a maintainer adds `ready-to-translate` to a PR, this opens an issue in -# exercism/i18n to translate the PR's English. The logic lives in -# exercism/i18n/.github/workflows/source-queue.yml, which explains every job -# and why it is fork-safe. This file holds only the trigger and the -# permissions the called jobs may use. +# When a maintainer adds the `ready-to-translate` label to a PR, this workflow +# opens an issue in exercism/i18n asking for the PR's English to be translated. +# The work happens in exercism/i18n/.github/workflows/source-queue.yml. This +# file only sets when it runs and what it is allowed to do. # -# `pull_request_target` gives fork PRs this repo's secrets, and nothing here -# checks out or runs the PR's code. The called workflow checks out only -# exercism/i18n at main. `secrets: inherit` passes on the organisation secret -# EXERCISM_I18N_APP_PRIVATE_KEY, from which the called jobs mint a token for -# exercism/i18n issues. +# It runs on `pull_request_target` so that PRs from forks can use the +# organisation's secrets. That is safe because nothing in this workflow checks +# out or runs code from the PR. It only checks out exercism/i18n. +# `secrets: inherit` passes on the Exercism i18n app's private key, which the +# workflow uses to open the issue. name: i18n queue