Skip to content

Commit 35ae909

Browse files
authored
Merge pull request #11009 from rhysd/inputs-context
Describe `inputs` context in contexts page
2 parents c92199e + 991af51 commit 35ae909

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

content/actions/learn-github-actions/contexts.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,7 @@ Contexts are a way to access information about workflow runs, runner environment
4141
| `strategy` | `object` | Enables access to the configured strategy parameters and information about the current job. Strategy parameters include `fail-fast`, `job-index`, `job-total`, and `max-parallel`. |
4242
| `matrix` | `object` | Enables access to the matrix parameters you configured for the current job. For example, if you configure a matrix build with the `os` and `node` versions, the `matrix` context object includes the `os` and `node` versions of the current job. |
4343
| `needs` | `object` | Enables access to the outputs of all jobs that are defined as a dependency of the current job. For more information, see [`needs` context](#needs-context). |
44+
| `inputs` | `object` | Enables access to the inputs of reusable workflow. For more information, see [`inputs` context](#inputs-context). |
4445

4546
As part of an expression, you may access context information using one of two syntaxes.
4647
- Index syntax: `github['sha']`
@@ -148,6 +149,17 @@ The `needs` context contains outputs from all jobs that are defined as a depende
148149
| `needs.<job id>.outputs.<output name>` | `string` | The value of a specific output for a job that the current job depends on. |
149150
| `needs.<job id>.result` | `string` | The result of a job that the current job depends on. Possible values are `success`, `failure`, `cancelled`, or `skipped`. |
150151

152+
### `inputs` context
153+
154+
The `inputs` context contains information about the inputs of reusable workflow. The inputs are defined in [`workflow_call` event configuration](/actions/learn-github-actions/events-that-trigger-workflows#workflow-reuse-events). These inputs are passed from [`jobs.<job_id>.with`](/actions/learn-github-actions/workflow-syntax-for-github-actions#jobsjob_idwith) in an external workflow.
155+
156+
For more information, see "[Reusing workflows](/actions/learn-github-actions/reusing-workflows)".
157+
158+
| Property name | Type | Description |
159+
|---------------|------|-------------|
160+
| `inputs` | `object` | This context is only available when it is [a reusable workflow](/actions/learn-github-actions/reusing-workflows). |
161+
| `inputs.<name>` | `string` or `number` or `boolean` | Each input value passed from an external workflow. |
162+
151163
#### Example printing context information to the log file
152164

153165
To inspect the information that is accessible in each context, you can use this workflow file example.

0 commit comments

Comments
 (0)