@@ -2,25 +2,25 @@ name: Documentation
22
33on :
44 push :
5- branches : [ main ]
5+ branches : [main]
66 paths :
7- - ' **.md'
8- - ' docs/**'
9- - ' .github/workflows/docs.yml'
10- - ' book.toml'
11- - ' CHANGELOG.md'
12- - ' CONTRIBUTING.md'
13- - ' CLAUDE.md'
7+ - " **.md"
8+ - " docs/**"
9+ - " .github/workflows/docs.yml"
10+ - " book.toml"
11+ - " CHANGELOG.md"
12+ - " CONTRIBUTING.md"
13+ - " CLAUDE.md"
1414 pull_request :
15- branches : [ main ]
15+ branches : [main]
1616 paths :
17- - ' **.md'
18- - ' docs/**'
19- - ' .github/workflows/docs.yml'
20- - ' book.toml'
21- - ' CHANGELOG.md'
22- - ' CONTRIBUTING.md'
23- - ' CLAUDE.md'
17+ - " **.md"
18+ - " docs/**"
19+ - " .github/workflows/docs.yml"
20+ - " book.toml"
21+ - " CHANGELOG.md"
22+ - " CONTRIBUTING.md"
23+ - " CLAUDE.md"
2424
2525# Cancel previous runs of the same workflow
2626concurrency :
@@ -33,14 +33,12 @@ jobs:
3333 name : Markdown Lint
3434 runs-on : ubuntu-latest
3535 steps :
36- - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
36+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
3737
3838 - name : Setup Node.js
3939 uses : actions/setup-node@v4
4040 with :
41- node-version : ' 20'
42- cache : ' npm'
43- cache-dependency-path : ' **/package-lock.json'
41+ node-version : " 20"
4442
4543 - name : Install markdownlint-cli
4644 run : npm install -g markdownlint-cli
@@ -52,14 +50,14 @@ jobs:
5250 --ignore target \
5351 --ignore docs/book \
5452 --disable MD013 MD033 MD041
55- continue-on-error : true # Don't fail CI for markdown issues
53+ continue-on-error : true # Don't fail CI for markdown issues
5654
5755 # Build and test mdBook documentation
5856 mdbook :
5957 name : Build Documentation
6058 runs-on : ubuntu-latest
6159 steps :
62- - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
60+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
6361
6462 - name : Cache mdBook
6563 uses : actions/cache@v4
@@ -85,14 +83,14 @@ jobs:
8583 run : |
8684 cd docs
8785 mdbook test
88- continue-on-error : true # Don't fail CI if examples are outdated
86+ continue-on-error : true # Don't fail CI if examples are outdated
8987
9088 # Check for broken links in documentation
9189 link-check :
9290 name : Check Links
9391 runs-on : ubuntu-latest
9492 steps :
95- - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
93+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
9694
9795 - name : Link Checker
9896 uses : lycheeverse/lychee-action@v2
@@ -109,17 +107,17 @@ jobs:
109107 --exclude "https://github.com/joshrotenberg/redisctl/pull/.*"
110108 --exclude "https://github.com/joshrotenberg/redisctl/issues/.*"
111109 .
112- continue-on-error : true # Don't fail CI for broken external links
110+ continue-on-error : true # Don't fail CI for broken external links
113111
114112 # Validate that documentation is in sync with code
115113 doc-validation :
116114 name : Validate Documentation
117115 runs-on : ubuntu-latest
118116 steps :
119- - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
117+ - uses : actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
120118
121119 - name : Install Rust
122- uses : dtolnay/rust-toolchain@7b1c307e0dcbda6122208f10795a713336a9b35a # stable
120+ uses : dtolnay/rust-toolchain@7b1c307e0dcbda6122208f10795a713336a9b35a # stable
123121 with :
124122 toolchain : stable
125123
0 commit comments