GH-200 · Question #27
When reviewing an action for use, what file defines its available inputs and outputs?
Every GitHub Action must include an action.yml metadata file in its root directory, and this file is the sole place where the action's inputs and outputs are declared.
Question
When reviewing an action for use, what file defines its available inputs and outputs?
Options
- Ainputs.yml
- Bdefaults.json
- Cworkflow.yml
- Dconfig.json
- Eaction.yml
Why each option
Every GitHub Action must include an action.yml metadata file in its root directory, and this file is the sole place where the action's inputs and outputs are declared.
inputs.yml is not a recognized GitHub Actions file format; inputs are declared inside action.yml, not in a separate dedicated file.
defaults.json does not exist in the GitHub Actions specification; there is no JSON-based metadata format for defining action inputs and outputs.
workflow.yml files (under .github/workflows/) define pipeline orchestration and call actions, but they do not define an action's own input and output interface.
config.json is not a GitHub Actions metadata format; the required metadata file must be YAML-formatted and named action.yml or action.yaml.
Concept tested: GitHub Action metadata file inputs and outputs definition
Source: https://docs.github.com/en/actions/sharing-automations/creating-actions/metadata-syntax-for-github-actions
Topics
Community Discussion
No community discussion yet for this question.