Skip to content

Commit 08c448f

Browse files
committed
docs: modify lind-wasm pipeline docs and add test links
1 parent 7dcb2cc commit 08c448f

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

docs/contribute/pipelines/lind-wasm.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# lind-wasm
22

3-
Its pipeline covers both code validation on pull requests and scheduled Docker image builds.
3+
Its pipeline covers both code validation on pull requests and Docker image builds.
44

55
## Overview
66

@@ -22,7 +22,10 @@ Workflow files are located under `.github/workflows/` in the repository.
2222
and static analysis.
2323

2424
- **`e2e.yml`** — Builds and runs the full test suite inside a container. Uploads
25-
HTML and JSON test reports as artifacts and posts a summary comment to the PR.
25+
HTML and JSON test reports as artifacts and posts a summary comment to the PR.
26+
27+
- [Testing](../testing.md) for details on test.
28+
- [End-to-End Testing](../e2e-testing.md) for details on e2e structure.
2629

2730
- **`zizmor.yml`** — Scans GHA workflow files for security vulnerabilities such as
2831
script injection and overly broad permissions.
@@ -38,11 +41,9 @@ PR to keep storage usage under control.
3841

3942
| Event | Workflows Triggered |
4043
| --- | --- |
41-
| PR opened or updated | `lint.yml`, `e2e.yml`, `zizmor.yml` |
42-
| Push to `main` | `lint.yml`, `e2e.yml`, `docs.yml` |
44+
| PR opened or updated (non-draft, targeting `main`) | `lint.yml`, `e2e.yml`, `zizmor.yml` |
45+
| Push to `main` | `lint.yml`, `docs.yml`, `release.yml` |
4346
| PR closed | `pr-cache-cleanup.yml` |
44-
| Monthly schedule (1st of each month, 08:00 UTC) | `release.yml` |
45-
| Manual (`workflow_dispatch`) | `release.yml` |
4647

4748

4849
## GCP Cloud Build
@@ -51,15 +52,15 @@ Build configuration files are located under `scripts/` in the repository.
5152

5253
### Workflows
5354

54-
- **`dev-build`** — Cloning the `main` branch at the time of execution. Builds `Docker/Dockerfile.dev` and publishes the resulting image to Docker Hub as `securesystemslab/lind-wasm-dev`.
55+
**`dev-build`** — Cloning the `main` branch at the time of execution. Builds `Docker/Dockerfile.dev` and publishes the resulting image to Docker Hub as `securesystemslab/lind-wasm-dev`.
5556

5657
## Docker Images
5758

5859
The `lind-wasm` pipeline publishes two Docker images to Docker Hub.
5960

6061
### `securesystemslab/lind-wasm-dev`
6162

62-
The development image containing the full Lind toolchain for building and running WASM applications.
63+
The development image containing the full Lind toolchain for building and running WASM applications. Used as the base image for `lind-wasm-apps` and `lind-wasm-example-grates`.
6364

6465
| Property | Detail |
6566
| --- | --- |
@@ -70,14 +71,13 @@ The development image containing the full Lind toolchain for building and runnin
7071

7172
### `securesystemslab/lind-wasm`
7273

73-
The release image built from the `release` stage of `Docker/Dockerfile.e2e`.
74-
7574
| Property | Detail |
7675
| --- | --- |
7776
| Source | `Docker/Dockerfile.e2e` (`release` stage) |
78-
| Published by | GHA `release.yml` (monthly) |
77+
| Published by | GHA `release.yml` (on push to `main`) |
7978
| Tags | `latest` — most recent build; `sha-<commit>` — immutable snapshot for rollback |
80-
| Update frequency | Monthly (1st of each month, 08:00 UTC) |
79+
| Version tags | `vX.Y.Z` — manually applied after a corresponding GitHub Release is created (e.g. `v0.1.0`) |
80+
| Update frequency | On every push to `main` |
8181

8282
### Pulling the Images
8383

0 commit comments

Comments
 (0)