inputs type are undocumented / contradicting

Open
#44,770 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
48/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Quiet
Tech stack
github-actions
Domain
documentation

Research direction

Compare the input-type descriptions in content/actions/reference/workflows-and-actions/workflow-syntax.md, events-that-trigger-workflows.md, and the contexts section linked in the issue. Start by checking the documented types and the environment behavior against the referenced anchors. Done means the relevant pages consistently document the supported input types and resolve the apparent contradiction.

Written by the indexing model from the issue text.

Description

content github_actions needs SME never-stale Waiting on SME review
Code of Conduct
What article on docs.github.com is affected? / What part(s) of the article would you like to see updated?
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

Dominant language
TypeScript
Stars
20.9k
Forks
68.8k
Avg merge
13h 43m
Merged PRs (30d)
110

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from github/docs

All issues in github/docs

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.