Reviewing the metadata syntax
The metadata syntax required to create an action must be written using YAML. If you are not familiar with YAML, start by reading the Introduction to YAML section in Chapter 1, Learning the Foundations for GitHub Actions.
Important note
The metadata filename must be either action.yaml
or action.yml
.
Most elements in a YAML file are organized in key-value pairs. That format is also used in the action metadata syntax. This chapter presents a list of all required keys that you must add to an action metadata file, as follows:
name
: The name of your action, which will also be displayed in the Actions tab of your GitHub repository.description
: A description of your action.runs
: Determines the application used to run the code.For Docker actions, this key configures the image used for the Docker action.
For JavaScript actions, this key configures the path to the location where the code that builds the action lives.
For composite run...