Skip to content

Commit db8358f

Browse files
committed
docs: drop the e2e badge from README; the existing CI already covers the demo
The demo is verified by the existing ci.yml (the `demo` static job and the `integration` job that runs the demo's queries against a live Spark Connect server). Remove the separate e2e badge and reword the demo section to lead with that CI coverage; the browser e2e run is mentioned as additional coverage. Co-authored-by: Isaac
1 parent d47e553 commit db8358f

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
# pyspark-connect-web - PySpark in JupyterLite
44

55
[![CI](https://github.com/HyukjinKwon/pyspark-client-wasm/actions/workflows/ci.yml/badge.svg)](https://github.com/HyukjinKwon/pyspark-client-wasm/actions/workflows/ci.yml)
6-
[![e2e](https://github.com/HyukjinKwon/pyspark-client-wasm/actions/workflows/e2e.yml/badge.svg)](https://github.com/HyukjinKwon/pyspark-client-wasm/actions/workflows/e2e.yml)
76
[![PyPI](https://img.shields.io/pypi/v/pyspark-connect-web.svg)](https://pypi.org/project/pyspark-connect-web/)
87
[![Docs](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://hyukjinkwon.github.io/pyspark-client-wasm/)
98
[![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)](LICENSE)
@@ -218,12 +217,13 @@ docker compose -f deploy/compose.yaml up # Spark Connect + Envoy + static host
218217
open http://localhost:8000/demo/
219218
```
220219

221-
It is **covered by CI on every push**: a static gate validates the page JS and
222-
the embedded in-browser Python on the cheap [`ci.yml`](.github/workflows/ci.yml)
223-
`demo` job (no browser), and the real browser run - boot, seed, list tables,
224-
`DESCRIBE`, run SQL, assert the result grid - is driven against the live stack by
225-
[`tests/e2e/demo.spec.ts`](tests/e2e/demo.spec.ts) in
226-
[`e2e.yml`](.github/workflows/e2e.yml). See [`demo/README.md`](demo/README.md).
220+
It is **covered by [CI](.github/workflows/ci.yml) on every push**: a static gate
221+
validates the page JS and the embedded in-browser Python (`demo` job), and
222+
[`tests/integration/test_demo_queries.py`](tests/integration/test_demo_queries.py)
223+
runs the demo's queries against a live Spark Connect server over the grpc-web
224+
bridge (`integration` job, no browser). The full page is additionally driven in a
225+
real browser by [`tests/e2e/demo.spec.ts`](tests/e2e/demo.spec.ts). See
226+
[`demo/README.md`](demo/README.md).
227227

228228
### DataFrame API examples
229229

0 commit comments

Comments
 (0)