Skip to content

Commit

Permalink
describe how to use Docker image in steps on GitHub Actions (fix #146)
Browse files Browse the repository at this point in the history
  • Loading branch information
rhysd committed Aug 12, 2022
1 parent aeee6f1 commit 0b86cab
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -207,6 +207,23 @@ shellcheck is [pre-installed on Ubuntu worker][preinstall-ubuntu].
If you want to [annotate errors][ga-annotate-error] from actionlint on GitHub, consider to use
[Problem Matchers](#problem-matchers).

If you prefer Docker image to running a downloaded executable, using [actionlint Docker image](#docker) is another option.

```yaml
name: Lint GitHub Actions workflows
on: [push, pull_request]

jobs:
actionlint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Check workflow files
uses: docker://rhysd/actionlint:latest
with:
args: -color
```

## Online playground

Thanks to WebAssembly, actionlint playground is available on your browser. It never sends any data to outside of your browser.
Expand Down

0 comments on commit 0b86cab

Please sign in to comment.