[FEATURE] Add useful CI job summaries #6

Open
opened 2026-11-12 21:24:34 +01:00 by erikinkinen · 0 comments
Owner

Problem and motivation

Reviewing this repository's CI requires reading long logs to find outcomes and evidence. Native job summaries should make that information easy to find.

Proposed behavior and scope

Publish a concise Markdown summary for each executed CI job in lib-elf, using FORGEJO_STEP_SUMMARY and Integration's shared reporting contract. Include the source commit, provider snapshot when applicable, check outcomes, useful counts/timings and links to logs or artifacts.

Apply this to .github/workflows/ci.yml.

Authority, security and reliability

Write only to the runner-provided summary file and approved existing outputs. Escape dynamic Markdown, keep secrets and private paths out, and preserve original exit statuses and all validation, timeout and authority checks. Missing evidence must stay explicit; reporting cannot turn a failure or skipped check into a pass.

Acceptance criteria

  • Adopt the shared summary contract in every maintained workflow job, with best-effort failure finalization.
  • Show useful outcomes and evidence links; distinguish passed, failed, skipped and unavailable results.
  • Verify actual rendered success and failure summaries, including missing evidence, safe text handling and unchanged job results.
  • Keep shared reporting code, regression tests and format documentation centralized; link the relevant implementation PRs and CI runs.

Alternatives and tradeoffs

Keep full logs and artifacts for detailed investigation. Reuse Integration's reporting contract rather than maintaining a separate formatter or copied test suite here.

Tracking and rollout

Alpha 1 work, dependent on the shared CI job-summary implementation. See the shared rollout for the contract and rollout checklist.

## Problem and motivation Reviewing this repository's CI requires reading long logs to find outcomes and evidence. Native job summaries should make that information easy to find. ## Proposed behavior and scope Publish a concise Markdown summary for each executed CI job in `lib-elf`, using `FORGEJO_STEP_SUMMARY` and Integration's shared reporting contract. Include the source commit, provider snapshot when applicable, check outcomes, useful counts/timings and links to logs or artifacts. Apply this to `.github/workflows/ci.yml`. ## Authority, security and reliability Write only to the runner-provided summary file and approved existing outputs. Escape dynamic Markdown, keep secrets and private paths out, and preserve original exit statuses and all validation, timeout and authority checks. Missing evidence must stay explicit; reporting cannot turn a failure or skipped check into a pass. ## Acceptance criteria - [ ] Adopt the shared summary contract in every maintained workflow job, with best-effort failure finalization. - [ ] Show useful outcomes and evidence links; distinguish passed, failed, skipped and unavailable results. - [ ] Verify actual rendered success and failure summaries, including missing evidence, safe text handling and unchanged job results. - [ ] Keep shared reporting code, regression tests and format documentation centralized; link the relevant implementation PRs and CI runs. ## Alternatives and tradeoffs Keep full logs and artifacts for detailed investigation. Reuse Integration's reporting contract rather than maintaining a separate formatter or copied test suite here. ## Tracking and rollout Alpha 1 work, dependent on the shared CI job-summary implementation. See [the shared rollout](https://git.erikinkinen.fi/erix/integration/issues/780) for the contract and rollout checklist.
erikinkinen added this to the Alpha 1 milestone 2026-11-12 21:24:34 +01:00
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
erix/lib-elf#6
No description provided.