[FEATURE] Roll out CI job summaries across EriX #780

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

Problem and motivation

CI results are scattered across long logs. Reviewers need a concise account of what ran, what failed and where to find the evidence. Forgejo 17 and Runner 13.2 now support native job summaries.

Proposed behavior and scope

Publish readable Markdown summaries for every executed job in maintained EriX workflows, using FORGEJO_STEP_SUMMARY. Include the source commit and provider snapshot when applicable, check outcomes, useful counts and timings, and links to logs and produced artifacts. Distinguish passed, failed, skipped and unavailable results.

Keep the shared format, reporting helper and regression tests in Integration. Meta supplies templates for new repositories; existing repositories adopt the shared contract through their own workflows. Document the format in Docs.

Authority, security and reliability

Use the runner-provided summary file and existing evidence. Do not expose credentials, private paths or raw untrusted output. Escape dynamic Markdown and avoid shell interpolation of untrusted text. Reporting must preserve the original job result and existing validation, timeout and authority checks. A summary is an index to evidence, not proof of acceptance or review approval.

Acceptance criteria

  • Implement the shared format and reporting helper, including summaries for Integration's own jobs.
  • Show useful source identity, outcomes, counts/timings and evidence links without duplicating full logs.
  • Cover success, failure, timeout, cancellation, missing evidence, unsafe Markdown and secret redaction. If a runner is killed before finalization, report incomplete evidence rather than inventing success.
  • Demonstrate rendered summaries from real successful and failing CI jobs; preserve failure status when reporting also fails.
  • Update Meta templates and Docs, and complete the linked repository adoption issues.

Alternatives and tradeoffs

Logs and uploaded receipts remain authoritative, but require more effort to inspect. Small shared summaries improve navigation without copying reporting code or tests into every repository.

Tracking and rollout

This is an Alpha 1 requirement. Start with the shared contract, then templates and repository adoption. Related: EriX delivery tracking. Repository issues are linked below.

Repository adoption

## Problem and motivation CI results are scattered across long logs. Reviewers need a concise account of what ran, what failed and where to find the evidence. Forgejo 17 and Runner 13.2 now support native job summaries. ## Proposed behavior and scope Publish readable Markdown summaries for every executed job in maintained EriX workflows, using `FORGEJO_STEP_SUMMARY`. Include the source commit and provider snapshot when applicable, check outcomes, useful counts and timings, and links to logs and produced artifacts. Distinguish passed, failed, skipped and unavailable results. Keep the shared format, reporting helper and regression tests in Integration. Meta supplies templates for new repositories; existing repositories adopt the shared contract through their own workflows. Document the format in Docs. ## Authority, security and reliability Use the runner-provided summary file and existing evidence. Do not expose credentials, private paths or raw untrusted output. Escape dynamic Markdown and avoid shell interpolation of untrusted text. Reporting must preserve the original job result and existing validation, timeout and authority checks. A summary is an index to evidence, not proof of acceptance or review approval. ## Acceptance criteria - [ ] Implement the shared format and reporting helper, including summaries for Integration's own jobs. - [ ] Show useful source identity, outcomes, counts/timings and evidence links without duplicating full logs. - [ ] Cover success, failure, timeout, cancellation, missing evidence, unsafe Markdown and secret redaction. If a runner is killed before finalization, report incomplete evidence rather than inventing success. - [ ] Demonstrate rendered summaries from real successful and failing CI jobs; preserve failure status when reporting also fails. - [ ] Update Meta templates and Docs, and complete the linked repository adoption issues. ## Alternatives and tradeoffs Logs and uploaded receipts remain authoritative, but require more effort to inspect. Small shared summaries improve navigation without copying reporting code or tests into every repository. ## Tracking and rollout This is an Alpha 1 requirement. Start with the shared contract, then templates and repository adoption. Related: [EriX delivery tracking](https://git.erikinkinen.fi/erix/integration/issues/65). Repository issues are linked below. ### Repository adoption - [ ] Integration workflows (tracked in this issue). - [ ] [blockd](https://git.erikinkinen.fi/erix/blockd/issues/9) - [ ] [boot-tool](https://git.erikinkinen.fi/erix/boot-tool/issues/29) - [ ] [bootloader](https://git.erikinkinen.fi/erix/bootloader/issues/27) - [ ] [coreutils](https://git.erikinkinen.fi/erix/coreutils/issues/26) - [ ] [crashd](https://git.erikinkinen.fi/erix/crashd/issues/5) - [ ] [deviced](https://git.erikinkinen.fi/erix/deviced/issues/15) - [ ] [docs](https://git.erikinkinen.fi/erix/docs/issues/95) - [ ] [drv-acpi](https://git.erikinkinen.fi/erix/drv-acpi/issues/5) - [ ] [drv-i8042](https://git.erikinkinen.fi/erix/drv-i8042/issues/5) - [ ] [drv-ps2-keyboard](https://git.erikinkinen.fi/erix/drv-ps2-keyboard/issues/6) - [ ] [drv-ps2-mouse](https://git.erikinkinen.fi/erix/drv-ps2-mouse/issues/6) - [ ] [drv-rtc-cmos](https://git.erikinkinen.fi/erix/drv-rtc-cmos/issues/5) - [ ] [drv-serial](https://git.erikinkinen.fi/erix/drv-serial/issues/14) - [ ] [drv-virtio-block](https://git.erikinkinen.fi/erix/drv-virtio-block/issues/7) - [ ] [dynlinkd](https://git.erikinkinen.fi/erix/dynlinkd/issues/13) - [ ] [e2fsd](https://git.erikinkinen.fi/erix/e2fsd/issues/60) - [ ] [exsh](https://git.erikinkinen.fi/erix/exsh/issues/136) - [ ] [extop](https://git.erikinkinen.fi/erix/extop/issues/13) - [ ] [fatd](https://git.erikinkinen.fi/erix/fatd/issues/40) - [ ] [fbcond](https://git.erikinkinen.fi/erix/fbcond/issues/7) - [ ] [hotplugd](https://git.erikinkinen.fi/erix/hotplugd/issues/6) - [ ] [inputd](https://git.erikinkinen.fi/erix/inputd/issues/7) - [ ] [irqd](https://git.erikinkinen.fi/erix/irqd/issues/5) - [ ] [kernel](https://git.erikinkinen.fi/erix/kernel/issues/128) - [ ] [keyd](https://git.erikinkinen.fi/erix/keyd/issues/5) - [ ] [launchd](https://git.erikinkinen.fi/erix/launchd/issues/98) - [ ] [lib-aes](https://git.erikinkinen.fi/erix/lib-aes/issues/9) - [ ] [lib-block](https://git.erikinkinen.fi/erix/lib-block/issues/10) - [ ] [lib-bootimg](https://git.erikinkinen.fi/erix/lib-bootimg/issues/5) - [ ] [lib-bootstrap](https://git.erikinkinen.fi/erix/lib-bootstrap/issues/25) - [ ] [lib-capabi](https://git.erikinkinen.fi/erix/lib-capabi/issues/24) - [ ] [lib-cli](https://git.erikinkinen.fi/erix/lib-cli/issues/21) - [ ] [lib-console](https://git.erikinkinen.fi/erix/lib-console/issues/8) - [ ] [lib-constant-time](https://git.erikinkinen.fi/erix/lib-constant-time/issues/6) - [ ] [lib-crc](https://git.erikinkinen.fi/erix/lib-crc/issues/7) - [ ] [lib-cstd](https://git.erikinkinen.fi/erix/lib-cstd/issues/114) - [ ] [lib-deflate](https://git.erikinkinen.fi/erix/lib-deflate/issues/5) - [ ] [lib-device](https://git.erikinkinen.fi/erix/lib-device/issues/6) - [ ] [lib-driver](https://git.erikinkinen.fi/erix/lib-driver/issues/6) - [ ] [lib-dynlink](https://git.erikinkinen.fi/erix/lib-dynlink/issues/18) - [ ] [lib-ed25519](https://git.erikinkinen.fi/erix/lib-ed25519/issues/5) - [ ] [lib-elf](https://git.erikinkinen.fi/erix/lib-elf/issues/6) - [ ] [lib-fs-crypto](https://git.erikinkinen.fi/erix/lib-fs-crypto/issues/7) - [ ] [lib-fs-name](https://git.erikinkinen.fi/erix/lib-fs-name/issues/5) - [ ] [lib-handoff](https://git.erikinkinen.fi/erix/lib-handoff/issues/7) - [ ] [lib-input](https://git.erikinkinen.fi/erix/lib-input/issues/6) - [ ] [lib-interrupt](https://git.erikinkinen.fi/erix/lib-interrupt/issues/6) - [ ] [lib-ipc](https://git.erikinkinen.fi/erix/lib-ipc/issues/192) - [ ] [lib-log](https://git.erikinkinen.fi/erix/lib-log/issues/6) - [ ] [lib-owned-region](https://git.erikinkinen.fi/erix/lib-owned-region/issues/7) - [ ] [lib-partition](https://git.erikinkinen.fi/erix/lib-partition/issues/7) - [ ] [lib-posixabi](https://git.erikinkinen.fi/erix/lib-posixabi/issues/83) - [ ] [lib-service](https://git.erikinkinen.fi/erix/lib-service/issues/6) - [ ] [lib-sha2](https://git.erikinkinen.fi/erix/lib-sha2/issues/7) - [ ] [lib-stdio](https://git.erikinkinen.fi/erix/lib-stdio/issues/20) - [ ] [lib-time](https://git.erikinkinen.fi/erix/lib-time/issues/11) - [ ] [lib-tty](https://git.erikinkinen.fi/erix/lib-tty/issues/17) - [ ] [lib-vfs](https://git.erikinkinen.fi/erix/lib-vfs/issues/13) - [ ] [loaderd](https://git.erikinkinen.fi/erix/loaderd/issues/34) - [ ] [logd](https://git.erikinkinen.fi/erix/logd/issues/13) - [ ] [memd](https://git.erikinkinen.fi/erix/memd/issues/6) - [ ] [meta](https://git.erikinkinen.fi/erix/meta/issues/11) - [ ] [named](https://git.erikinkinen.fi/erix/named/issues/7) - [ ] [pagerd](https://git.erikinkinen.fi/erix/pagerd/issues/6) - [ ] [posixd](https://git.erikinkinen.fi/erix/posixd/issues/156) - [ ] [powerboxd](https://git.erikinkinen.fi/erix/powerboxd/issues/9) - [ ] [probed](https://git.erikinkinen.fi/erix/probed/issues/7) - [ ] [procd](https://git.erikinkinen.fi/erix/procd/issues/60) - [ ] [ramfsd](https://git.erikinkinen.fi/erix/ramfsd/issues/48) - [ ] [rootd](https://git.erikinkinen.fi/erix/rootd/issues/60) - [ ] [seriald](https://git.erikinkinen.fi/erix/seriald/issues/15) - [ ] [sha2-tool](https://git.erikinkinen.fi/erix/sha2-tool/issues/30) - [ ] [timed](https://git.erikinkinen.fi/erix/timed/issues/13) - [ ] [ttyd](https://git.erikinkinen.fi/erix/ttyd/issues/50) - [ ] [vfsd](https://git.erikinkinen.fi/erix/vfsd/issues/129) - [ ] [vspaced](https://git.erikinkinen.fi/erix/vspaced/issues/6)
erikinkinen added this to the Alpha 1 milestone 2026-11-12 21:24:25 +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/integration#780
No description provided.