docs: document report log retention - #155
Open
sylvesterkaczmarek wants to merge 1 commit into
Open
Conversation
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
1 participant
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
Document that
FENCE_REPORT_JSONremains retrievable only while the GitHub Actions job log exists.Why
The current fetch example reads the machine-readable report from the job log, but does not state that workflow logs are retained for a limited period. Consumers using a healthy block-mode report as durable evidence can otherwise discover later that the report can no longer be re-fetched.
Change
Add one sentence next to the report-fetching example advising consumers that need durable evidence to capture the report while the log is still available.
No runtime or reporting behavior changes.
Closes #154