github / github/docs

inputs type are undocumented / contradicting

Aberta
#44,770 2 comentários 1 reação 0 responsáveis Ver no GitHub
content github_actions needs SME
Linguagem predominante
TypeScript
Estrelas
20.8k
Forks
68.7k
Merge médio
13h 17min
PRs com merge (30d)
110

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? / What part(s) of the article would you like to see updated?

- workflow-syntax#onworkflow_dispatchinputsinput_idtype
- https://docs.github.com/en/actions/reference/workflows-and-actions/workflow-syntax#onworkflow_dispatchinputsinput_idtype
- https://github.com/github/docs/blob/fa4d1bcf57215fe0eae198c42d3b83f8679402a1/content/actions/reference/workflows-and-actions/workflow-syntax.md?plain=1#L264-L266
- events-that-trigger-workflows#providing-inputs
- https://docs.github.com/en/actions/reference/workflows-and-actions/events-that-trigger-workflows#providing-inputs
- https://github.com/github/docs/blob/fa4d1bcf57215fe0eae198c42d3b83f8679402a1/content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md?plain=1#L1076-L1130
- contexts#inputs-context
- https://docs.github.com/en/actions/reference/workflows-and-actions/contexts#inputs-context
- https://github.com/github/docs/blob/fa4d1bcf57215fe0eae198c42d3b83f8679402a1/content/actions/reference/workflows-and-actions/workflow-syntax.md?plain=1#L162-L164

### Additional information

Input types are undocumented / contradicting

Particularly "environment", which, as per the documentation, seems to be a special sub-type of choice automatically populating the enum with the names of the repository's environment, but this is just a guess from the only screenshot available in the documentation

Given this, there might also even be other types

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

Compare as descrições dos tipos de entrada em content/actions/reference/workflows-and-actions/workflow-syntax.md, events-that-trigger-workflows.md e na seção contexts vinculada na issue. Comece verificando os tipos documentados e o comportamento de `environment` em relação às âncoras referenciadas. A tarefa estará concluída quando as páginas relevantes documentarem de forma consistente os tipos de entrada compatíveis e resolverem a aparente contradição.

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
3/5
Tempo estimado
1-2 dias
Status de atividade
Pouca atividade
Clareza
Precisa de esclarecimento
Facilidade para iniciantes
48/100

Receba novas issues na sua caixa de entrada

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