@test-station/cli 0.2.12 → 0.2.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +29 -0
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -269,6 +269,35 @@ Typical prerequisite:
|
|
|
269
269
|
yarn playwright install --with-deps
|
|
270
270
|
```
|
|
271
271
|
|
|
272
|
+
### Publishing CI Runs To `/api/ingest`
|
|
273
|
+
|
|
274
|
+
The deployed server accepts machine reports at `POST /api/ingest` with shared-key auth. The checked-in GitHub Actions workflow publishes the self-test report to `https://test-station.smysnk.com/api/ingest`.
|
|
275
|
+
|
|
276
|
+
What is sent:
|
|
277
|
+
|
|
278
|
+
- `report.json` as the canonical run payload
|
|
279
|
+
- run metadata from GitHub Actions such as repository, branch, tag, commit SHA, actor, run URL, workflow, run number, attempt, and build start/end timestamps
|
|
280
|
+
- artifact metadata for every file under the report output directory, including `report.json`, `modules.json`, `ownership.json`, `index.html`, and everything under `raw/`
|
|
281
|
+
|
|
282
|
+
Shared-key auth:
|
|
283
|
+
|
|
284
|
+
- the server reads `INGEST_SHARED_KEY`
|
|
285
|
+
- the CI workflow reads the GitHub Actions secret `TEST_STATION_INGEST_SHARED_KEY`
|
|
286
|
+
- set them to the same value
|
|
287
|
+
|
|
288
|
+
Optional S3-backed artifact storage:
|
|
289
|
+
|
|
290
|
+
- set `vars.TEST_STATION_ARTIFACT_S3_BUCKET` to enable `aws s3 sync` of the report directory
|
|
291
|
+
- optionally set `vars.TEST_STATION_ARTIFACT_STORAGE_PREFIX` to control the object prefix
|
|
292
|
+
- optionally set `vars.TEST_STATION_ARTIFACT_BASE_URL` when the uploaded artifacts are browser-accessible through S3 static hosting, CloudFront, or another CDN
|
|
293
|
+
- set `secrets.TEST_STATION_ARTIFACT_AWS_ACCESS_KEY_ID` and `secrets.TEST_STATION_ARTIFACT_AWS_SECRET_ACCESS_KEY` for the sync credentials
|
|
294
|
+
|
|
295
|
+
Current storage model:
|
|
296
|
+
|
|
297
|
+
- the ingest endpoint stores artifact metadata, storage keys, and source URLs in Postgres
|
|
298
|
+
- it does not upload binary artifacts itself
|
|
299
|
+
- without S3 or another external artifact host, the server still records artifact inventory but not downloadable remote URLs
|
|
300
|
+
|
|
272
301
|
### Raw Artifact Contract
|
|
273
302
|
|
|
274
303
|
Suites can attach raw artifacts that will be written under `raw/` and linked from the HTML report.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@test-station/cli",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.14",
|
|
4
4
|
"publishConfig": {
|
|
5
5
|
"access": "public"
|
|
6
6
|
},
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
".": "./src/index.js"
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@test-station/core": "0.2.
|
|
16
|
-
"@test-station/render-html": "0.2.
|
|
15
|
+
"@test-station/core": "0.2.14",
|
|
16
|
+
"@test-station/render-html": "0.2.14"
|
|
17
17
|
},
|
|
18
18
|
"scripts": {
|
|
19
19
|
"build": "node ../../scripts/check-package.mjs ./src/index.js && node --check ./src/cli.js",
|