Skip to content
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

Merged
merged 5 commits into from
Jul 11, 2024

Conversation

davidg-dq
Copy link
Contributor

@davidg-dq davidg-dq commented Jul 2, 2024

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

  1. Use axe-devhub-action in your CI process
  2. Observe action output after a run

ref: #1219

@davidg-dq davidg-dq requested a review from a team as a code owner July 2, 2024 09:25
@CLAassistant
Copy link

CLAassistant commented Jul 2, 2024

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
2 out of 3 committers have signed the CLA.

✅ dbjorge
✅ davidg-dq
❌ David Garrett


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.

@Zidious
Copy link
Contributor

Zidious commented Jul 2, 2024

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?

In terms of what's being outputted to the GHA terminal or what's intended to be outputted as a comment on the PR?

dbjorge
dbjorge previously requested changes Jul 2, 2024
Copy link

@dbjorge dbjorge left a 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"
Copy link

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.

Copy link
Contributor Author

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?

Copy link

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

main.sh Outdated Show resolved Hide resolved
main.sh Show resolved Hide resolved
@davidg-dq
Copy link
Contributor Author

davidg-dq commented Jul 3, 2024

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?

In terms of what's being outputted to the GHA terminal or what's intended to be outputted as a comment on the PR?

In terms of what is being added to the GITHUB_OUTPUT for subsequent steps to access. Should I rename variables to use the last_run.... naming convention or just stick with what we have, so we don't break anyone's GH actions?

@davidg-dq davidg-dq dismissed dbjorge’s stale review July 3, 2024 11:23

Addressed comments

@davidg-dq davidg-dq requested review from dbjorge and a team July 3, 2024 11:23
@dbjorge
Copy link

dbjorge commented Jul 3, 2024

I think we should avoid making a breaking change.

@davidg-dq
Copy link
Contributor Author

@dbjorge @Zidious
It looks like cla-assistant isn't recognizing that my GH account has signed the CLA. I've clicked "recheck" several times and nothing happens, but when I go to the link, it shows that I've accepted. I've also added my email to my local git config. Any ideas? Maybe I need to create a new branch with a new PR since my earlier commits didn't have my email address attached? Or perhaps it's okay for us to bypass this for this PR?

image

image

image

@dbjorge
Copy link

dbjorge commented Jul 11, 2024

@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)

@dbjorge dbjorge merged commit 8883eb7 into main Jul 11, 2024
8 of 9 checks passed
@dbjorge dbjorge deleted the feat-1219-new-data-in-gha-ouput branch July 11, 2024 12:47
@davidg-dq
Copy link
Contributor Author

@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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants