@@ -17,7 +17,7 @@ Features:
17
17
- ** Other several useful checks** ; [ glob syntax] [ filter-pattern-doc ] validation, dependencies check for ` needs: ` ,
18
18
runner label validation, cron syntax validation, ...
19
19
20
- See [ the full list] [ checks ] of checks done by actionlint.
20
+ See the [ full list] [ checks ] of checks done by actionlint.
21
21
22
22
<img src =" https://github.com/rhysd/ss/blob/master/actionlint/main.gif?raw=true " alt =" actionlint reports 7 errors " width =" 806 " height =" 492 " />
23
23
@@ -82,18 +82,6 @@ test.yaml:22:17: receiver of object dereference "permissions" must be type of ob
82
82
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
83
83
` ` `
84
84
85
- ## Why?
86
-
87
- - **Running a workflow is time consuming.** You need to push the changes and wait until the workflow runs on GitHub even if
88
- it contains some trivial mistakes. [act][] is useful to debug the workflow locally. But it is not suitable for CI and still
89
- time consuming when your workflow gets larger.
90
- - **Checks of workflow files by GitHub are very loose.** It reports no error even if unexpected keys are in mappings
91
- (meant that some typos in keys). And also it reports no error when accessing to property which is actually not existing.
92
- For example ` matrix.foo` when no `foo` is defined in `matrix:` section, it is evaluated to `null` and causes no error.
93
- - **Some mistakes silently break a workflow.** Most common case I saw is specifying missing property to cache key. In the
94
- case cache silently does not work properly but a workflow itself runs without error. So you might not notice the mistake
95
- forever.
96
-
97
85
## Quick start
98
86
99
87
Install ` actionlint` command by downloading [the released binary][releases] or by Homebrew or by `go install`. See
@@ -133,6 +121,8 @@ See [the usage document][usage] for more details.
133
121
When you see some bugs or false positives, it is helpful to [file a new issue][issue-form] with a minimal example
134
122
of input. Giving me some feedbacks like feature requests or ideas of additional checks is also welcome.
135
123
124
+ See the [contribution guide](./CONTRIBUTING.md) for more details.
125
+
136
126
# # License
137
127
138
128
actionlint is distributed under [the MIT license](./LICENSE.txt).
@@ -145,7 +135,6 @@ actionlint is distributed under [the MIT license](./LICENSE.txt).
145
135
[playground] : https://rhysd.github.io/actionlint/
146
136
[shellcheck] : https://github.com/koalaman/shellcheck
147
137
[pyflakes] : https://github.com/PyCQA/pyflakes
148
- [act] : https://github.com/nektos/act
149
138
[syntax-doc] : https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
150
139
[filter-pattern-doc] : https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
151
140
[script-injection-doc] : https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#understanding-the-risk-of-script-injections
0 commit comments