jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 11:26:57 -05:00
Code Issues Projects Releases Wiki Activity

Actions: Add deprecationMessage metadata syntax field

Browse Source
This commit is contained in:
Simran
2021-03-31 00:28:12 +02:00
committed by GitHub
parent a9d66a78ba
commit 442ecf1b0c
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
content/actions/creating-actions/metadata-syntax-for-github-actions.md
View File

@@ -58,7 +58,7 @@ inputs:
When you specify an input to an action in a workflow file or use a default input value, {% data variables.product.prodname_dotcom %} creates an environment variable for the input with the name `INPUT_<VARIABLE_NAME>`. The environment variable created converts input names to uppercase letters and replaces spaces with `_` characters.
For example, if a workflow defined the numOctocats and octocatEyeColor inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables.
For example, if a workflow defined the `numOctocats` and `octocatEyeColor` inputs, the action code could read the values of the inputs using the `INPUT_NUMOCTOCATS` and `INPUT_OCTOCATEYECOLOR` environment variables.
#### `inputs.<input_id>`
@@ -76,6 +76,10 @@ For example, if a workflow defined the numOctocats and octocatEyeColor inputs, t
**Optional** A `string` representing the default value. The default value is used when an input parameter isn't specified in a workflow file.
#### `inputs.<input_id>.deprecationMessage`
**Optional** A `string` to be logged as warning if the input is set. You can notify users to not use this input parameter anymore by setting a deprecation warning for it.
### `outputs`
**Optional** Output parameters allow you to declare data that an action sets. Actions that run later in a workflow can use the output data set in previously run actions. For example, if you had an action that performed the addition of two inputs (x + y = z), the action could output the sum (z) for other actions to use as an input.