Clarify vars context availability in composite actions
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 74/100
- Tipo de issue
- Documentação
- Clareza
- Claramente especificada
- Status de atividade
- Ativa
- Stack de tecnologia
- github-actions, typescript
- Domínio
- documentation
Direção de pesquisa
Leia a referência de contexts e o artigo sobre composite actions vinculados na issue e, em seguida, verifique como essas páginas estão organizadas no repositório docs. Esclareça que os valores de que uma composite action precisa, incluindo valores de vars, devem ser passados por meio de inputs; use os exemplos da issue para verificar se as orientações são consistentes nas duas páginas.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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
- Linguagem predominante
- TypeScript
- Estrelas
- 21k
- Forks
- 69k
- Merge médio
- 8h 37min
- PRs com merge (30d)
- 117
Preparar o ambiente
Inicia o contêiner de desenvolvimento do projeto no navegador, com a sua própria conta do GitHub.
- Inclui um Dockerfile ou arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de github/docs
-
builder persona triage
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 83/100
Mantenedores costumam responder em até 1 dia
-
content driver persona triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
Mantenedores costumam responder em até 1 dia
-
triage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
github/docs#46222 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
builder persona content
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
github/docs#46190 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
Add user-level custom agent configurationTalvez já em andamento @ashis-baral assumiu há 7 dias. Abertabuilder persona content copilot
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 90/100
Mantenedores costumam responder em até 1 dia
Todas as issues de github/docs
Issues semelhantes
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 84/100
Mantenedores costumam responder em até 1 dia
-
core
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
vectorize-io/hindsight#5457 ·
Mantenedores costumam responder em até 1 dia
-
beginner friendly community contributions-welcome good first issue hacktoberfest help wanted testing up-for-grabs
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
lukilabs/beautiful-mermaid#160 ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
rescript-lang/rescript-lang.org#1420 ·
Mantenedores costumam responder em até 2 dias