Skip to content

Commit cae9c3e

Browse files
committed
remove outdated section from readme and small fixes
1 parent 44e0643 commit cae9c3e

File tree

3 files changed

+5
-16
lines changed

3 files changed

+5
-16
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ ronn ./man/actionlint.1.ronn
120120
or
121121

122122
```sh
123-
make ./man/actionlint.1
123+
make man
124124
```
125125

126126
## How to develop playground

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ all: build test lint
2323

2424
t test: .testtimestamp
2525

26-
.linttimestamp: $(TESTS) $(SRCS) $(TOOL)
26+
.linttimestamp: $(TESTS) $(SRCS) $(TOOL) docs/checks.md
2727
go vet ./...
2828
staticcheck ./...
2929
GOOS=js GOARCH=wasm staticcheck ./playground

README.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Features:
1717
- **Other several useful checks**; [glob syntax][filter-pattern-doc] validation, dependencies check for `needs:`,
1818
runner label validation, cron syntax validation, ...
1919

20-
See [the full list][checks] of checks done by actionlint.
20+
See the [full list][checks] of checks done by actionlint.
2121

2222
<img src="https://github.com/rhysd/ss/blob/master/actionlint/main.gif?raw=true" alt="actionlint reports 7 errors" width="806" height="492"/>
2323

@@ -82,18 +82,6 @@ test.yaml:22:17: receiver of object dereference "permissions" must be type of ob
8282
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
8383
```
8484
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-
9785
## Quick start
9886
9987
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.
133121
When you see some bugs or false positives, it is helpful to [file a new issue][issue-form] with a minimal example
134122
of input. Giving me some feedbacks like feature requests or ideas of additional checks is also welcome.
135123

124+
See the [contribution guide](./CONTRIBUTING.md) for more details.
125+
136126
## License
137127

138128
actionlint is distributed under [the MIT license](./LICENSE.txt).
@@ -145,7 +135,6 @@ actionlint is distributed under [the MIT license](./LICENSE.txt).
145135
[playground]: https://rhysd.github.io/actionlint/
146136
[shellcheck]: https://github.com/koalaman/shellcheck
147137
[pyflakes]: https://github.com/PyCQA/pyflakes
148-
[act]: https://github.com/nektos/act
149138
[syntax-doc]: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
150139
[filter-pattern-doc]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
151140
[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

Comments
 (0)