Add support for Step Summary #1642
Merged
Conversation
This file contains 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
pfleidi
requested review from
soelinn,
TingluoHuang,
yacaovsnc,
konradpabjan,
robherley and
SrRyan
pfleidi
commented
Jan 31, 2022
thboop
reviewed
Feb 1, 2022
thboop
reviewed
Feb 1, 2022
thboop
reviewed
Feb 1, 2022
thboop
reviewed
Feb 1, 2022
thboop
reviewed
Feb 1, 2022
thboop
reviewed
Feb 1, 2022
TingluoHuang
reviewed
Feb 1, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
| return false; | ||
| } | ||
|
|
||
| if (String.IsNullOrEmpty(filePath)) |
There was a problem hiding this comment.
i would combine all file exit/empty checks into a single if and trace.
There was a problem hiding this comment.
@TingluoHuang I found the separate trace statements useful when testing/debugging. I guess now that I have unit tests for all of them, they might not be as useful any more. Is that what you're aiming at?
There was a problem hiding this comment.
we can revisit this when you inline all the methods. my main goal is to get the minimal key tracing, ex: we don't upload the summary because it's not there or empty.
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 3, 2022
TingluoHuang
reviewed
Feb 4, 2022
TingluoHuang
reviewed
Feb 4, 2022
TingluoHuang
approved these changes
Feb 4, 2022
AdamOlech
pushed a commit
to antmicro/runner
that referenced
this pull request
Aug 8, 2022
* First prototype of step summary environment variable * Fix file contention issue * Try to simplify cleaning up file references * use step id as md file name, queue file attachment * separate logic into attachment summary func * Fix indentation * Add (experimental) feature flag support * reorganize summary upload determination logic * file i/o exception handling + pr feedback * Revert changes for now to reintroduce them later * Add skeleton SetStepSummaryCommand * Update step summary feature flag name * Port ShouldUploadAttachment from previous iteration * Port QueueStepSummaryUpload from previous iteration * Improve exception handling when uploading attachment * Add some minor logging improvements * Refuse to upload files larger than 128k * Implement secrets scrubbing * Add TODO comment to remove debugging temp files * Add first tests * Add test for secret masking * Add some naming/style fixes suggested in feedback * inline check for feature flag * Inline method for style consistency * Make sure that scrubbed file doesn't exist before creating it * Rename SetStepSummaryCommand to CreateStepSummaryCommand * Fix error handling messages * Fix file command name when registering extension * Remove unnecessary file deletion Co-authored-by: Rob Herley <robherley@github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is a work in progress: I'm opening this as a draft to get some feedback while figuring out how to properly test those changes.
What does this change?
The changes in this PR will generate a unique file name per step run and make it available via the
$GITHUB_STEP_SUMMARYenvironment variable. After a step finished executing, the contents of the file are uploaded as an attachment.