Skip to content

Commit df1ecfb

Browse files
committed
Ensure getting_started.md is included in sclicheck.DocTests
1 parent e3ad47e commit df1ecfb

File tree

3 files changed

+6
-4
lines changed

3 files changed

+6
-4
lines changed

README.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,8 +197,9 @@ To just check the documents, run:
197197
./mill -i docs-tests.test 'sclicheck.DocTests.*'
198198
```
199199

200-
You can also check all commands, guides or cookbooks:
200+
You can also check all root docs, commands, guides or cookbooks:
201201
```bash
202+
./mill -i docs-tests.test 'sclicheck.DocTests.root*'
202203
./mill -i docs-tests.test 'sclicheck.DocTests.guide*'
203204
./mill -i docs-tests.test 'sclicheck.DocTests.command*'
204205
./mill -i docs-tests.test 'sclicheck.DocTests.cookbook*'

modules/docs-tests/src/test/scala/sclicheck/DocTests.scala

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ class DocTests extends munit.FunSuite {
1919
os.read.lines(f).exists(lineContainsAnyChecks)
2020

2121
for {
22-
(tpe, dir) <- dirs
23-
inputs = os.walk(dir)
22+
(tpe, dir) <- dirs :+ ("root", docsRootPath)
23+
maxDepth = if dir == docsRootPath then 1 else Int.MaxValue
24+
inputs = os.walk(dir, maxDepth = maxDepth)
2425
.filter(_.last.endsWith(".md"))
2526
.filter(os.isFile(_))
2627
.filter(fileContainsAnyChecks)

website/docs/release_notes.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Added by [@lwronski](https://github.com/lwronski) in https://github.com/VirtusLa
172172
### Fixes in Scala Native binaries caching
173173

174174
When running a sequence of commands such as
175-
```bash
175+
```bash ignore
176176
$ scala-cli run --native .
177177
$ scala-cli package --native . -o my-app
178178
```

0 commit comments

Comments
 (0)