Skip to content

docs(gha): correct status-emoji description and document per-run comment reset #49

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
raphaelvigee merged 1 commit into from
Jun 25, 2026
Merged

docs(gha): correct status-emoji description and document per-run comment reset #49

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 13 additions & 8 deletions website/docs/plugins/gha.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,8 @@ While the build runs the comment shows live progress:
</details>
```

The heading emoji reflects the current state: ⏳ while running, ✅ once every
matched target finishes without error, ❌ as soon as any target fails.
The heading emoji reflects the current state: ⏳ while the command is running,
✅ once the command finishes without error, ❌ if any target failed.

A total shown as `~40` means the matcher hasn't resolved all targets yet; the
tilde drops once resolution is complete.
Expand All @@ -137,9 +137,14 @@ address and the first line of its error message.

## One comment per job, one section per step

The comment is scoped by `GITHUB_JOB` — one comment per CI job, reused across
reruns (found by a hidden HTML marker, never duplicated). Within the comment,
each heph invocation owns a section keyed by its command line (the arguments
passed to `heph`). A job with three separate `heph run` steps produces one
comment with three independently-updated sections, so earlier steps' results
are preserved as later steps write theirs.
The comment is scoped by `GITHUB_JOB` — one comment per CI job, never
duplicated (found by a hidden HTML marker). Within the comment, each heph
invocation owns a section keyed by its command line (the arguments passed to
`heph`). A job with three separate `heph run` steps produces one comment with
three independently-updated sections, so earlier steps' results are preserved
as later steps write theirs.

Each new workflow run (identified by `GITHUB_RUN_ID` and `GITHUB_RUN_ATTEMPT`)
starts the comment fresh — the previous build's sections are cleared when the
first step of a new run writes to the comment. Steps within the same run
continue to preserve each other's sections as described above.
Loading