github / github/docs

inputs type are undocumented / contradicting

Open
#44,770 2 comments 1 reaction 0 assignees View on GitHub
content github_actions needs SME
Dominant language
TypeScript
Stars
20.8k
Forks
68.7k
Avg merge
13h 17m
Merged PRs (30d)
110

Description

### 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

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.