obsidian-plugin/fancive_obsidian-parallel-reader
1
0
Fork 0
mirror of https://github.com/fancive/obsidian-parallel-reader.git synced 2026-07-22 06:53:43 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: trim e2e gate section in readme

Browse source 
Drop the self-contained/no-Python historical note and the contributor-
focused tests/catalog.json paragraph; keep the gate command + TEST_LIVE=1
hint. Public README does not need internal test classification details.

Change-Id: Ic7a2ed45af0ebeb3be227aed03079ce258ed30c2
This commit is contained in:
fancivez 2026-05-02 12:51:19 +08:00 committed by wujunchen
parent 01ec934d28
commit c10c641949
2 changed files with 6 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -131,20 +131,13 @@ npm run test:contract
npm run test:e2e # packaged plugin + disposable Vault smoke
```
The project also has a host-neutral e2e contract gate for product-shell smoke
evidence:
For CI / release evidence, run the contract gate:
```bash
bash .e2e/gate.sh --json
bash .e2e/gate.sh --json # writes .e2e/artifact.json (gitignored)
```
The gate is self-contained — `.e2e/gate.sh` runs the bundled Node-based contract checker directly, no external Python validator required. Runtime evidence such as `.e2e/artifact.json` and `.e2e/results/` is generated locally and ignored by git.
Test classification lives in `tests/catalog.json`. `verify` owns unit,
component, contract, and local integration checks. Mocked Obsidian/runtime tests
are classified as component or contract tests, not product e2e. The `.e2e` gate
intentionally includes only the default product-shell smoke plus optional live
local Vault/provider checks with `TEST_LIVE=1`.
Add `TEST_LIVE=1` to opt into real local Vault / provider checks.
## Star History

11
README.zh-CN.md
View file

@ -131,18 +131,13 @@ npm run test:contract
npm run test:e2e # 打包插件 + 临时 Vault smoke
```
项目还提供一个与宿主环境解耦的 e2e contract gate，用于产品壳 smoke 证据：
CI / 发布前跑一次 contract gate 留证据：
```bash
bash .e2e/gate.sh --json
bash .e2e/gate.sh --json # 写出 .e2e/artifact.json（已 gitignore）
```
该 gate 是自包含的 —— `.e2e/gate.sh` 直接运行仓库内的 Node 版 contract checker，不需要额外的 Python 校验器。`.e2e/artifact.json`、`.e2e/results/` 等运行证据只在本地生成，并已被 git 忽略。
测试分类的来源是 `tests/catalog.json`。`verify` 负责 unit、component、contract
和本地 integration 检查。使用 mock Obsidian/runtime 的测试归为 component 或
contract，不声明为产品 e2e。`.e2e` gate 只包含默认产品壳 smoke，以及通过
`TEST_LIVE=1` 显式开启的真实本地 Vault/provider 检查。
`TEST_LIVE=1` 可开启真实本地 Vault / provider 检查。
## Star History