You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/checks.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2793,7 +2793,7 @@ branding:
2793
2793
2794
2794
runs:
2795
2795
# ERROR: Node.js runtime version is too old
2796
-
using: 'node14'
2796
+
using: 'node16'
2797
2797
# ERROR: The source file being run by this action does not exist
2798
2798
main: 'this-file-does-not-exist.js'
2799
2799
# ERROR: 'env' configuration is only allowed for Docker actions
@@ -2818,27 +2818,27 @@ Output:
2818
2818
<!-- Skip update output -->
2819
2819
2820
2820
```
2821
-
action_metadata_syntax_validation.yaml:8:15: description is required in metadata of "My action" action at "path/to/.github/actions/my-invalid-action/action.yml" [action]
2821
+
test.yaml:8:15: description is required in metadata of "My action" action at "/Users/rhysd/.go/src/github.com/rhysd/actionlint/.github/actions/my-invalid-action/action.yml" [action]
2822
2822
|
2823
2823
8 | - uses: ./.github/actions/my-invalid-action
2824
2824
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2825
-
action_metadata_syntax_validation.yaml:8:15: incorrect icon name "dog" at branding.icon in metadata of "My action" action at "path/to/.github/actions/my-invalid-action/action.yml". see the official document to know the exhaustive list of supported icons: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingicon[action]
2825
+
test.yaml:8:15: incorrect icon name "dog" at branding.icon in metadata of "My action" action at "/Users/rhysd/.go/src/github.com/rhysd/actionlint/.github/actions/my-invalid-action/action.yml". see the official document to know the exhaustive list of supported icons: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingicon[action]
2826
2826
|
2827
2827
8 | - uses: ./.github/actions/my-invalid-action
2828
2828
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2829
-
action_metadata_syntax_validation.yaml:8:15: incorrect color "black" at branding.icon in metadata of "My action" action at "path/to/.github/actions/my-invalid-action/action.yml". see the official document to know the exhaustive list of supported colors: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingcolor[action]
2829
+
test.yaml:8:15: incorrect color "black" at branding.icon in metadata of "My action" action at "/Users/rhysd/.go/src/github.com/rhysd/actionlint/.github/actions/my-invalid-action/action.yml". see the official document to know the exhaustive list of supported colors: https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#brandingcolor[action]
2830
2830
|
2831
2831
8 | - uses: ./.github/actions/my-invalid-action
2832
2832
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2833
-
action_metadata_syntax_validation.yaml:8:15: invalid runner name "node14" at runs.using in "My action" action defined at "path/to/.github/actions/my-invalid-action". valid runners are "composite", "docker", "node16", and "node20". see https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs[action]
2833
+
test.yaml:8:15: invalid runner name "node16" at runs.using in "My action" action defined at "/Users/rhysd/.go/src/github.com/rhysd/actionlint/.github/actions/my-invalid-action". valid runners are "composite", "docker", and "node20". see https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions#runs[action]
2834
2834
|
2835
2835
8 | - uses: ./.github/actions/my-invalid-action
2836
2836
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2837
-
action_metadata_syntax_validation.yaml:8:15: file "this-file-does-not-exist.js" does not exist in "path/to/.github/actions/my-invalid-action". it is specified at "main" key in "runs" section in "My action" action [action]
2837
+
test.yaml:8:15: file "this-file-does-not-exist.js" does not exist in "/Users/rhysd/.go/src/github.com/rhysd/actionlint/.github/actions/my-invalid-action". it is specified at "main" key in "runs" section in "My action" action [action]
2838
2838
|
2839
2839
8 | - uses: ./.github/actions/my-invalid-action
2840
2840
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2841
-
action_metadata_syntax_validation.yaml:8:15: "env" is not allowed in "runs" section because "My action" is a JavaScript action. the action is defined at "path/to/.github/actions/my-invalid-action" [action]
2841
+
test.yaml:8:15: "env" is not allowed in "runs" section because "My action" is a JavaScript action. the action is defined at "/Users/rhysd/.go/src/github.com/rhysd/actionlint/.github/actions/my-invalid-action" [action]
2842
2842
|
2843
2843
8 | - uses: ./.github/actions/my-invalid-action
2844
2844
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -2851,7 +2851,7 @@ All actions require a metadata file `action.yml` or `action.yaml`. The syntax is
2851
2851
actionlint checks metadata files used in workflows and reports errors when they are not following the syntax.
2852
2852
2853
2853
- `name:`, `description:`, `runs:` sections are required
2854
-
- Runner name at `using:` is one of `composite`, `docker`, `node16`, `node20`
2854
+
- Runner name at `using:` is one of `composite`, `docker`, `node20`
2855
2855
- Keys under `runs:` section are correct. Required/Valid keys are different depending on the type of action; Docker action or
2856
2856
Composite action or JavaScript action (e.g. `image:` is required for Docker action).
2857
2857
- Files specified in some keys under `runs` are existing. For example, JavaScript action defines a script file path for
0 commit comments