Skip to content

Commit c7a09e0

Browse files
committed
update readme document to link to the latest stable version of docs
1 parent c270d66 commit c7a09e0

File tree

2 files changed

+19
-14
lines changed

2 files changed

+19
-14
lines changed

README.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
actionlint
22
==========
33
[![CI Badge][]][CI]
4-
[![API Document][api-badge]][apidoc]
4+
[![API Document][apidoc-badge]][apidoc]
55

66
[actionlint][repo] is a static checker for GitHub Actions workflow files. [Try it online!][playground]
77

@@ -97,7 +97,7 @@ test.yaml:22:17: receiver of object dereference "permissions" must be type of ob
9797
## Quick start
9898

9999
Install `actionlint` command by downloading [the released binary][releases] or by Homebrew or by `go install`. See
100-
[the installation document](docs/install.md) for more details like how to manage the command with several package managers
100+
[the installation document][install] for more details like how to manage the command with several package managers
101101
or run via Docker container.
102102

103103
```sh
@@ -114,19 +114,19 @@ actionlint
114114

115115
Another option to try actionlint is [the online playground][playground]. Your browser can run actionlint through WebAssembly.
116116

117-
See [the usage document](docs/usage.md) for more details.
117+
See [the usage document][usage] for more details.
118118

119119
## Documents
120120

121121
- [Checks][checks]: Full list of all checks done by actionlint with example inputs, outputs, and playground links.
122-
- [Installation](docs/install.md): Installation instructions. Prebuilt binaries, a Docker image, building from
123-
source, a download script (for CI), supports by several package managers are available.
124-
- [Usage](docs/usage.md): How to use `actionlint` command locally or on GitHub Actions, the online playground, an official Docker
125-
image, and integrations with reviewdog, Problem Matchers, super-linter, pre-commit, VS Code.
126-
- [Configuration](docs/config.md): How to configure actionlint behavior. Currently, the labels of self-hosted runners and the
127-
configuration variables can be set.
128-
- [Go API](docs/api.md): How to use actionlint as Go library.
129-
- [References](docs/reference.md): Links to resources.
122+
- [Installation][install]: Installation instructions. Prebuilt binaries, a Docker image, building from source, a download script
123+
(for CI), supports by several package managers are available.
124+
- [Usage][usage]: How to use `actionlint` command locally or on GitHub Actions, the online playground, an official Docker image,
125+
and integrations with reviewdog, Problem Matchers, super-linter, pre-commit, VS Code.
126+
- [Configuration][config]: How to configure actionlint behavior. Currently, the labels of self-hosted runners, the configuration
127+
variables, and ignore patterns of errors for each file paths can be set.
128+
- [Go API][api]: How to use actionlint as Go library.
129+
- [References][refs]: Links to resources.
130130

131131
## Bug reporting
132132

@@ -139,7 +139,7 @@ actionlint is distributed under [the MIT license](./LICENSE.txt).
139139

140140
[CI Badge]: https://github.com/rhysd/actionlint/workflows/CI/badge.svg?branch=main&event=push
141141
[CI]: https://github.com/rhysd/actionlint/actions?query=workflow%3ACI+branch%3Amain
142-
[api-badge]: https://pkg.go.dev/badge/github.com/rhysd/actionlint.svg
142+
[apidoc-badge]: https://pkg.go.dev/badge/github.com/rhysd/actionlint.svg
143143
[apidoc]: https://pkg.go.dev/github.com/rhysd/actionlint
144144
[repo]: https://github.com/rhysd/actionlint
145145
[playground]: https://rhysd.github.io/actionlint/
@@ -149,6 +149,11 @@ actionlint is distributed under [the MIT license](./LICENSE.txt).
149149
[syntax-doc]: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
150150
[filter-pattern-doc]: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet
151151
[script-injection-doc]: https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#understanding-the-risk-of-script-injections
152-
[issue-form]: https://github.com/rhysd/actionlint/issues/new
153152
[releases]: https://github.com/rhysd/actionlint/releases
154153
[checks]: https://github.com/rhysd/actionlint/blob/v1.7.3/docs/checks.md
154+
[install]: https://github.com/rhysd/actionlint/blob/v1.7.3/docs/install.md
155+
[usage]: https://github.com/rhysd/actionlint/blob/v1.7.3/docs/usage.md
156+
[config]: https://github.com/rhysd/actionlint/blob/v1.7.3/docs/config.md
157+
[api]: https://github.com/rhysd/actionlint/blob/v1.7.3/docs/api.md
158+
[refs]: https://github.com/rhysd/actionlint/blob/v1.7.3/docs/reference.md
159+
[issue-form]: https://github.com/rhysd/actionlint/issues/new

testdata/examples/main.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
- uses: actions/checkout@v4
1515
- uses: actions/setup-node@v4
1616
with:
17-
node_version: 16.x
17+
node_version: 18.x
1818
- uses: actions/cache@v4
1919
with:
2020
path: ~/.npm

0 commit comments

Comments
 (0)