|
3 | 3 | Every GitHub Action that we write needs to be accompanied by a metadata file. This file has a few rules to it, lets outline those now: |
4 | 4 |
|
5 | 5 | - Filename **must** be `action.yml` |
6 | | -- Placed in the root directory of your Action |
7 | 6 | - Required for both Docker container and JavaScript Actions |
8 | 7 | - Written in YAML syntax |
9 | 8 |
|
10 | 9 | This file defines the following information about your Action: |
11 | 10 |
|
12 | | -<details><summary>Name</summary>This parameter is <b>required</b>. The name of your action. Helps visually identify the Actions in a job.</details> |
13 | | -<details><summary>Author</summary>This parameter is <b>optional</b>. The name of who wrote the Action.</details> |
14 | | -<details><summary>Description</summary>This parameter is <b>required</b>. A summary of what your Action does.</details> |
15 | | -<details><summary>Inputs</summary>This parameter is <b>optional</b>. Input parameters allow you to specify data that the action expects to use during runtime. These parameters become environment variables in the runner.</details> |
16 | | -<details><summary>Outputs</summary>This parameter is <b>optional</b>. Specifies the data that subsequent actions can use later in the workflow after the action that defines these outputs has run.</details> |
17 | | -<details><summary>Runs</summary>This parameter is <b>required</b>. The command to run when the Action executes.</details> |
18 | | -<details><summary>Branding</summary>This parameter is <b>optional</b>. You can use a color and Feather icon to create a badge to personalize and distinguish your action in GitHub Marketplace.</details> |
| 11 | + |
| 12 | + |
| 13 | +| Parameter | Description | Required | |
| 14 | +| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------------: | |
| 15 | +| Name | The name of your Action. Helps visually identify the Actions in a job. | :white_check_mark: | |
| 16 | +| Description | A summary of what your Action does. | :white_check_mark: | |
| 17 | +| Inputs | Input parameters allow you to specify data that the action expects to use during runtime. These parameters become environment variables in the runner. | ❌ | |
| 18 | +| Outputs | Specifies the data that subsequent actions can use later in the workflow after the action that defines these outputs has run. | ❌ | |
| 19 | +| Runs | The command to run when the Action executes. | :white_check_mark: | |
| 20 | +| Branding | You can use a color and Feather icon to create a badge to personalize and distinguish your action in GitHub Marketplace. | ❌ | |
19 | 21 |
|
20 | 22 | --- |
21 | 23 |
|
|
0 commit comments