docs(gha): document failure annotations and machine-readable output - #90
Open
raphaelvigee wants to merge 1 commit into
Open
docs(gha): document failure annotations and machine-readable output#90raphaelvigee wants to merge 1 commit into
raphaelvigee wants to merge 1 commit into
Conversation
heph/hephbuild#376 adds `::error::` failure annotations, an immediate comment flush on the first failing target, `jsonPath`/`annotations` options, `$GITHUB_OUTPUT` keys, and the embedded JSON report in the step summary. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014w7wCdCTTGdPKKLLETVRKC
⚡ Cloudflare Pages preview
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new surfaces added by hephbuild/heph#376 (commit
e0316ab) to theghaplugin's docs page (website/docs/plugins/gha.md):::error::workflow command emitted per failing target, gated by the newannotationsoption (defaulttrue).refreshSecstick, then coalesces further failures on a 10s floor.jsonPathoption — writes the full run report as JSON when the run finishes.$GITHUB_OUTPUTkeys —heph_status,heph_failed,heph_blocked,heph_executed,heph_cached,heph_elapsed_ms,heph_elapsed,heph_cache_hit_rate,heph_json_path.All field names, defaults, and behavior were verified directly against
crates/plugin-gha/src/lib.rsandcrates/plugin-gha/src/report.rsonmaster(not from the design doc, which describes some fields not yet implemented).No new page was added;
plugins/gha.mdwas already registered insidebars.ts. No plugin skill reference twin exists forgha, so nothing else needed updating.Test plan
lint— not run in this session (no build env available here); should be clean, only prose/markdown changed.build— not run in this session; should succeed, no new page/asset added.hephbuild/hephonmaster.Generated by Claude Code