-
Notifications
You must be signed in to change notification settings - Fork 2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(gha): displays extra data in gha output #154
Conversation
David Garrett seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
In terms of what's being outputted to the GHA terminal or what's intended to be outputted as a comment on the PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A few suggestions inline. We probably want to defer merging this until after the updated API releases to prod to avoid breaking users that are referring to main
instead of v1
(ideally folks shouldn't be doing that, but we should probably avoid knowingly breaking folks that are anyway)
echo "issue_count=$IssueCount" >>"$GITHUB_OUTPUT" | ||
echo "created_at=$LastRunCreatedAt" >>"$GITHUB_OUTPUT" | ||
echo "issue_count=$LastRunViolationCount" >>"$GITHUB_OUTPUT" | ||
echo "new_issues=$LastRunNewViolationCount" >> "$GITHUB_OUTPUT" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
new_issues
, resolved_issues
, difference_in_page_states
are all only meaningful if there was a previous session for us to compare to. In the comparable summary UI we use for list items in the devhub frontend's "commits" view, we omit them if there wasn't a previous session.
I wonder if it might make more sense for us to update the walnut route to specify those properties as undefined or null if there wasn't a previous session, and to omit them here (from both GITHUB_OUTPUT
and stdout) if so.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that's a great idea. Would you like me to go ahead and work on modifying the output from the walnut route?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that'd be good, but it doesn't have to block this PR
In terms of what is being added to the GITHUB_OUTPUT for subsequent steps to access. Should I rename variables to use the |
I think we should avoid making a breaking change. |
@dbjorge @Zidious |
@davidg-dq I'll bypass it for this PR. If you did want to fix it up, you'd need the corrected email to apply to all the commits in the PR, which you could do either by amending the commits or by rebasing after having updated the email config (either way you'd need to force push to the PR branch) |
Thank you! |
This PR adds additional data to the output of the
axe-devhub-action
.Note: I may need to change the names of the variables we're outputting to be in line with what we use, but I'm not sure of this yet. @Zidious @dbjorge - Perhaps one of you can guide me on this?
QA Notes
axe-devhub-action
in your CI processref: #1219