Skip to content

Commit 8f92d03

Browse files
fix: exclude Playwright tests from CI and add live test result links
- Exclude Playwright tests from vitest.config.ci.ts (they require a running viewer and installed browser binaries not available in CI) - Add live test result links to README, docs homepage, CI/CD guide, and viewer getting-started page pointing to https://dotnetprofessional.github.io/LiveDoc/ Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 8e34966 commit 8f92d03

File tree

5 files changed

+49
-2
lines changed

5 files changed

+49
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
A **Living Documentation** platform that brings Gherkin-style BDD syntax to modern testing frameworks, enabling executable specifications that serve as living documentation.
99

10-
📖 **[Full Documentation →](https://livedoc.swedevtools.com/)**
10+
📖 **[Full Documentation →](https://livedoc.swedevtools.com/)** · 🔬 **[Live Test Results →](https://dotnetprofessional.github.io/LiveDoc/)**
1111

1212
## Packages
1313

@@ -81,7 +81,7 @@ public class CalculatorTests : FeatureTest
8181
-**Gherkin Syntax** — Write tests using Given/When/Then
8282
- 📊 **Data Tables & Scenario Outlines** — Data-driven testing
8383
- 🎯 **Tag Filtering** — Include/exclude tests by tags
84-
- 🖥️ **[Live Viewer](https://livedoc.swedevtools.com/viewer/learn/getting-started)** — Real-time web UI for test results
84+
- 🖥️ **[Live Viewer](https://livedoc.swedevtools.com/viewer/learn/getting-started)** — Real-time web UI for test results ([see a live example](https://dotnetprofessional.github.io/LiveDoc/vitest/))
8585
- 📋 **Beautiful Output** — Formatted, colored test results in your terminal
8686

8787
## License

docs/docs/index.mdx

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,36 @@ This works with any AI coding tool — **GitHub Copilot**, **Cursor**, **Claude
194194

195195
---
196196

197+
## See It Live
198+
199+
Want to see what LiveDoc produces? These reports are generated automatically by our CI pipeline on every commit:
200+
201+
<div className="sdk-grid">
202+
203+
<a className="sdk-card sdk-card--ts" href="https://dotnetprofessional.github.io/LiveDoc/vitest/" target="_blank" rel="noopener">
204+
205+
### Vitest Test Results
206+
207+
Browse the full LiveDoc Vitest test suite — features, specifications, and scenarios with pass/fail status, data tables, and step details.
208+
209+
**View Vitest Report →**
210+
211+
</a>
212+
213+
<a className="sdk-card sdk-card--dotnet" href="https://dotnetprofessional.github.io/LiveDoc/xunit/" target="_blank" rel="noopener">
214+
215+
### xUnit Test Results
216+
217+
Browse the LiveDoc xUnit test suite — BDD features, journey tests, and .NET specifications.
218+
219+
**View xUnit Report →**
220+
221+
</a>
222+
223+
</div>
224+
225+
---
226+
197227
## Choose Your SDK
198228

199229
<div className="sdk-grid">

docs/docs/viewer/learn/getting-started.mdx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,11 @@ graph LR
174174
- **Connect** via `LiveDocSpecReporter` (auto-discovers the viewer) or `LiveDocViewerReporter` (explicit URL)
175175
- **Run tests** and watch results stream into the browser
176176

177+
:::tip See it live
178+
Want to see what the viewer looks like with real test data? Browse LiveDoc's own published test results:
179+
**[Vitest →](https://dotnetprofessional.github.io/LiveDoc/vitest/)** · **[xUnit →](https://dotnetprofessional.github.io/LiveDoc/xunit/)**
180+
:::
181+
177182
---
178183

179184
## Next Steps

docs/docs/vitest/guides/ci-cd.mdx

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -253,6 +253,17 @@ livedoc-tests:
253253

254254
---
255255

256+
## Live Example
257+
258+
LiveDoc's own CI pipeline produces static HTML reports on every commit. See the results:
259+
260+
- **[Vitest Report →](https://dotnetprofessional.github.io/LiveDoc/vitest/)** — the LiveDoc Vitest test suite
261+
- **[xUnit Report →](https://dotnetprofessional.github.io/LiveDoc/xunit/)** — the LiveDoc xUnit test suite
262+
263+
These are generated using exactly the pipeline described above — JSON export, static HTML conversion, and GitHub Pages deployment.
264+
265+
---
266+
256267
## Troubleshooting
257268

258269
| Problem | Cause | Solution |

packages/vitest/vitest.config.ci.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ export default defineConfig({
99
globals: true,
1010
environment: 'node',
1111
include: ['_src/test/**/*.Spec.ts'],
12+
exclude: ['_src/test/Playwright/**'], // Playwright tests need a running viewer + browsers — run locally or in dedicated e2e job
1213
setupFiles: ['./_src/app/setup.ts'],
1314
pool: 'forks',
1415
fileParallelism: false,

0 commit comments

Comments
 (0)