Skip to content

Commit

Permalink
remove outdated section from readme and small fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Nov 14, 2024
1 parent 44e0643 commit cae9c3e
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ ronn ./man/actionlint.1.ronn
or

```sh
make ./man/actionlint.1
make man
```

## How to develop playground
Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ all: build test lint

t test: .testtimestamp

.linttimestamp: $(TESTS) $(SRCS) $(TOOL)
.linttimestamp: $(TESTS) $(SRCS) $(TOOL) docs/checks.md
go vet ./...
staticcheck ./...
GOOS=js GOARCH=wasm staticcheck ./playground
Expand Down
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Features:
- **Other several useful checks**; [glob syntax][filter-pattern-doc] validation, dependencies check for `needs:`,
runner label validation, cron syntax validation, ...

See [the full list][checks] of checks done by actionlint.
See the [full list][checks] of checks done by actionlint.

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

Expand Down Expand Up @@ -82,18 +82,6 @@ test.yaml:22:17: receiver of object dereference "permissions" must be type of ob
| ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
```
## Why?
- **Running a workflow is time consuming.** You need to push the changes and wait until the workflow runs on GitHub even if
it contains some trivial mistakes. [act][] is useful to debug the workflow locally. But it is not suitable for CI and still
time consuming when your workflow gets larger.
- **Checks of workflow files by GitHub are very loose.** It reports no error even if unexpected keys are in mappings
(meant that some typos in keys). And also it reports no error when accessing to property which is actually not existing.
For example `matrix.foo` when no `foo` is defined in `matrix:` section, it is evaluated to `null` and causes no error.
- **Some mistakes silently break a workflow.** Most common case I saw is specifying missing property to cache key. In the
case cache silently does not work properly but a workflow itself runs without error. So you might not notice the mistake
forever.

## Quick start
Install `actionlint` command by downloading [the released binary][releases] or by Homebrew or by `go install`. See
Expand Down Expand Up @@ -133,6 +121,8 @@ See [the usage document][usage] for more details.
When you see some bugs or false positives, it is helpful to [file a new issue][issue-form] with a minimal example
of input. Giving me some feedbacks like feature requests or ideas of additional checks is also welcome.

See the [contribution guide](./CONTRIBUTING.md) for more details.

## License

actionlint is distributed under [the MIT license](./LICENSE.txt).
Expand All @@ -145,7 +135,6 @@ actionlint is distributed under [the MIT license](./LICENSE.txt).
[playground]: https://rhysd.github.io/actionlint/
[shellcheck]: https://github.com/koalaman/shellcheck
[pyflakes]: https://github.com/PyCQA/pyflakes
[act]: https://github.com/nektos/act
[syntax-doc]: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
[filter-pattern-doc]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
[script-injection-doc]: https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#understanding-the-risk-of-script-injections
Expand Down

0 comments on commit cae9c3e

Please sign in to comment.