Inconsistent allowed contexts for reusable workflow secrets/inputs
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 72/100
- Tipo de issue
- Documentación
- Claridad
- Bastante claro
- Estado de actividad
- Activo
- Stack tecnológico
- markdown
- Área
- documentation
Línea de trabajo
Comienza comparando actions/reference/workflows-and-actions/contexts.md con actions/reference/workflows-and-actions/reusable-workflows.md, centrándote en las entradas jobs.<job_id>.secrets.<secret_id> y jobs.<job_id>.with.<input_id>. Resuelve los contextos permitidos documentados y alinea los nombres de las claves del workflow para que ambas páginas describan el mismo comportamiento.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
- https://docs.github.com/en/actions/reference/workflows-and-actions/contexts
- https://docs.github.com/en/actions/reference/workflows-and-actions/reusable-workflows
What part(s) of the article would you like to see updated?
I have found inconsistencies between the actions/reference/workflows-and-actions/contexts.md and the actions/reference/workflows-and-actions/reusable-workflows.md pages.
The reusable-workflows.md page defines contexts for jobs.<job_id>.secrets.<secret_id> and jobs.<job_id>.with.<input_id> like so:
## `jobs.<job_id>.with.<input_id>`
[...]
Allowed expression contexts: `github`, and `needs`.
## `jobs.<job_id>.secrets.<secret_id>`
[...]
Allowed expression contexts: `github`, `needs`, and `secrets`.
This seems to match observed behavior that the following using After testing in a different and cleaner environment, this actually does not match the observed behavior, as the following using vars, using a reusable workflow that requires a secret, does not work:vars, using a reusable workflow that requires a secret, does work:
jobs:
job:
uses: job.yml
secrets:
MY_SECRET: ${{ vars.MY_SECRET }}
Indeed, the contexts.md page defines these contexts like so:
| `jobs.<job_id>.secrets.<secrets_id>` | `github, needs, strategy, matrix, secrets, inputs, vars` | None |
| `jobs.<job_id>.with.<with_id>` | `github, needs, strategy, matrix, inputs, vars` | None |
So I would have expected vars to work in this context, but it does not.
Also while we are at it, note the workflow keys are not consistent: secrets_id vs secret_id, and with_id vs input_id.
Therefore I would suggest to:
- Rename the workflow keys in the
contexts.mdpage to match those in thereusable-workflows.mdpage, - Update the "allowed expression contexts" in the
reusable-workflows.mdpage to match what is described in thecontexts.mdpage.
Additional information
No response
- Lenguaje dominante
- TypeScript
- Estrellas
- 20.9k
- Forks
- 68.8k
- Merge medio
- 13 h 43 min
- PR fusionados (30 d)
- 110
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de github/docs
-
triage
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
-
localization
Dificultad 2/5 1-2 días Aptitud para principiantes 72/100
-
builder persona
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
-
content localization
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
-
content localization
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
Todos los issues de github/docs
Issues similares
-
[Bug]: Discord Activity titles with emoji are rejected as over 80 characters when they are not Abiertoclawsweeper:linked-pr-open clawsweeper:no-new-fix-pr clawsweeper:source-repro impact:message-loss issue-rating: 🦞 diamond lobster maturity:stable P2
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 84/100
Eynzof/Hermes-CN-Desktop#616 ·
-
ZCode 3.14.3 に対応する Abierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
supermomonga/zcode-acp#24 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
growthbook/growthbook#7100 ·
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 72/100
lobehub/lobe-icons#422 · 1 comentario ·