github / github/docs

Clarify 'description' key is optional for composite actions

Aberta
#43,910 5 comentários 0 reações 0 responsáveis Ver no GitHub
content github_actions
Linguagem predominante
TypeScript
Estrelas
20.8k
Forks
68.7k
Merge médio
13h 10min
PRs com merge (30d)
111

Descrição

### Code of Conduct

- [x] I have read and agree to the GitHub Docs project's [Code of Conduct](https://github.com/github/docs/blob/main/.github/CODE_OF_CONDUCT.md)

### What article on docs.github.com is affected?

https://docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax

### What part(s) of the article would you like to see updated?

For composite actions, the `description` key is not strictly required in the `action.yml` for the composite action to function correctly (see Additional Information for proof).

Instead of **Required** this should either have an addendum like in the pull request (that is, that `description` is not required for composite actions, or change **Required** to optional. In either case, it is probably worth it to state that a `description` key is highly recommended.

### Additional information

I just ran a workflow run that calls a composite action whose `action.yml` file did not include a description key at the time this workflow ran. The workflow ran as expected (all the composite action does is produce an output that gets passed to the calling workflow).

See https://github.com/mcummings128/gh-actions-outputs-experiments-1/actions/runs/24743176941 for details.
This commit SHA shows the description key was removed from the composite action during the time the workflow ran.
https://github.com/mcummings128/gh-actions-outputs-experiments-1/commit/6037d82f9910c7d186845393ab2b4a53617b2bde

Lastly, please see the pull request this is linked to: https://github.com/github/docs/pull/43911

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Comece pelo artigo sobre a sintaxe de metadados em docs.github.com/en/actions/reference/workflows-and-actions/metadata-syntax e revise o pull request vinculado para conferir a redação proposta. Atualize o requisito de descrição de composite-action para refletir que ele é opcional, observando ao mesmo tempo que é altamente recomendado, e depois verifique se o artigo é renderizado corretamente.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
github-actions
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
1/5
Tempo estimado
Menos de uma hora
Status de atividade
Estagnada
Clareza
Claramente especificada
Facilidade para iniciantes
25/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.