Skip to content

Commit b373471

Browse files
committed
chores - reorder smoke-all test running example inside README
1 parent 50e6ef3 commit b373471

File tree

1 file changed

+24
-24
lines changed

1 file changed

+24
-24
lines changed

tests/README.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -120,30 +120,6 @@ $env:QUARTO_TESTS_NO_CONFIG=$true
120120

121121
`docs/smoke-all/` is a specific folder to run some tests written directly within `.qmd`, `.md` or `.ipynb` files (but files starting with `_` will be ignored). They are run through the `smoke/smoke-all.tests.ts` script. To ease running smoke-all tests, `run-tests.sh` has a special behavior where it will run `./smoke/smoke-all.tests.ts` when passed a `.qmd`, `.md` or `.ipynb` file, not starting with `_`.
122122

123-
##### Controlling test execution with metadata
124-
125-
Smoke-all tests support metadata in the `_quarto` key to control when tests are run:
126-
127-
**Skip tests on CI:**
128-
129-
```yaml
130-
_quarto:
131-
tests-on-ci: false
132-
```
133-
134-
**Skip tests on specific operating systems:**
135-
136-
```yaml
137-
_quarto:
138-
skip-on-os: linux # Skip only on Linux
139-
skip-on-os: [linux, darwin] # Skip on Linux and macOS
140-
skip-on-os: windows # Skip only on Windows
141-
```
142-
143-
Valid OS values are: `linux`, `darwin` (macOS), `windows`
144-
145-
This is useful when tests require platform-specific dependencies or have known platform-specific issues that need separate investigation.
146-
147123
```bash
148124
# run tests for all documents in docs/smoke-all/
149125
./run-tests.sh smoke/smoke-all.tests.ts
@@ -243,6 +219,30 @@ ok | 1 passed | 0 failed (2s)
243219

244220
</details>
245221

222+
##### Controlling test execution with metadata
223+
224+
Smoke-all tests support metadata in the `_quarto` key to control when tests are run:
225+
226+
**Skip tests on CI:**
227+
228+
```yaml
229+
_quarto:
230+
tests-on-ci: false
231+
```
232+
233+
**Skip tests on specific operating systems:**
234+
235+
```yaml
236+
_quarto:
237+
skip-on-os: linux # Skip only on Linux
238+
skip-on-os: [linux, darwin] # Skip on Linux and macOS
239+
skip-on-os: windows # Skip only on Windows
240+
```
241+
242+
Valid OS values are: `linux`, `darwin` (macOS), `windows`
243+
244+
This is useful when tests require platform-specific dependencies or have known platform-specific issues that need separate investigation.
245+
246246
### Limitations
247247

248248
- `smoke-all.test.ts` accept only one argument. You need to use glob pattern to run several smoke-all test documents.

0 commit comments

Comments
 (0)