Clarify vars context availability in composite actions
Los mantenedores suelen responder en 1 día
Nadie ha tomado este issue todavía.
- #46249 de @alok-108 — cerrado sin fusionar
Evaluación
- Dificultad
- 2/5
- Tiempo estimado
- 1-3 horas
- Aptitud para principiantes
- 74/100
- Tipo de issue
- Documentación
- Claridad
- Bien especificado
- Estado de actividad
- Activo
- Stack tecnológico
- github-actions, typescript
- Área
- documentation
Línea de trabajo
Lee la referencia de contexts y el artículo sobre composite actions enlazados en el issue y, después, comprueba cómo están organizadas esas páginas en el repositorio de docs. Aclara que los valores que necesita una composite action, incluidos los valores de vars, deben pasarse mediante inputs; usa los ejemplos del issue para verificar que las indicaciones sean coherentes en ambas páginas.
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/sharing-automations/creating-actions/creating-a-composite-action
What part(s) of the article would you like to see updated?
The documentation is unclear about whether the vars context is available inside composite actions.
The contexts reference lists vars as an available context, which can reasonably lead users to assume that this works inside a composite action:
runs:
using: composite
steps:
- shell: bash
run: echo "${{ vars.AWS_REGION }}"
However, the Composite Actions ADR states:
"Composite actions should leverage inputs to get values they need, they will not have full access to the context objects."
There is also an implementation detail documented by a runner collaborator in actions/runner#4311: variables are filtered based on references made directly in the calling job, so a vars reference used only inside a composite action may not be available to the runner.
Could the composite actions documentation explicitly clarify that values required by a composite action should be passed through inputs, including values originating from vars?
For example:
- uses: ./my-action
with:
region: ${{ vars.AWS_REGION }}
and then inside the composite action:
${{ inputs.region }}
This would make the relationship between the general contexts documentation and the more limited context availability of composite actions clearer.
Thanks
Additional information
No response
- Lenguaje dominante
- TypeScript
- Estrellas
- 21k
- Forks
- 69k
- Merge medio
- 9 h 42 min
- PR fusionados (30 d)
- 110
Preparar el entorno
Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.
- Incluye un Dockerfile o un archivo de Docker Compose
- Tiene una plantilla de pull request
- Leer la 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
-
Broken page layout on non-English translated versions of "Models and pricing for GitHub Copilot"Posiblemente ocupada @alok-108 la tomó hoy. Abiertocontent localization
Dificultad 2/5 1-3 horas Aptitud para principiantes 69/100
github/docs#46269 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Should mention you need enterprise in order to get insightsPosiblemente ocupada @vrushabhakamdi-dev la tomó hace 2 días. Abiertocontent driver persona
Dificultad 2/5 1-3 horas Aptitud para principiantes 74/100
github/docs#46242 · 3 comentarios ·
Los mantenedores suelen responder en 1 día
-
Dependabot docs disagree on when the ecosystem label is added, and on its name (github-actions vs github_actions)Posiblemente ocupada @travisfortney la tomó hoy. Abiertobuilder persona help wanted
Dificultad 1/5 1-3 horas Aptitud para principiantes 83/100
github/docs#46230 · 1 comentario ·
Los mantenedores suelen responder en 1 día
-
Update model availability under data residency pageQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abiertocontent driver persona
Dificultad 2/5 1-3 horas Aptitud para principiantes 68/100
Los mantenedores suelen responder en 1 día
-
mention permissions required to jump the queueQuizá libre de nuevo Un pull request para esta issue se cerró sin fusionarse. Abiertobuilder persona content
Dificultad 2/5 1-3 horas Aptitud para principiantes 76/100
github/docs#46190 · 2 comentarios ·
Los mantenedores suelen responder en 1 día
Todos los issues de github/docs
Issues similares
-
bug help wanted
Dificultad 2/5 1-3 horas Aptitud para principiantes 82/100
Los mantenedores suelen responder en 1 día
-
agent-task risk:low
Dificultad 1/5 1-3 horas Aptitud para principiantes 88/100
guyellis/http-status-check#512 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
microsoft/playwright#43327 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
microsoft/TypeScript#64758 ·
Los mantenedores suelen responder en 1 día
-
enhancement
Dificultad 2/5 1-3 horas Aptitud para principiantes 65/100
opensearch-project/OpenSearch-Dashboards#12937 ·
Los mantenedores suelen responder en 2 días