Skip to content

Conversation

@anonymous-akorn
Copy link
Contributor

A small quality of life improvement. When opening the page to a failed job, Github Actions will automatically expand the last failing step. We can exploit this to automatically expand the summary step by forcing it to fail, which is the preferred starting point for figuring out what failed. Since we don't want to fail otherwise successful jobs, we only execute the summary step if a prior step failed. The summary is only needed when something fails.

This eliminates some navigation, as well as the knowledge burden of knowing to navigate to the summary step to get an overview of what went wrong.

When opening the page to a failed job, GHA will automatically expand the last failing step. We can exploit this to automatically expand the summary step, which is the preferred starting point for figuring out what failed.
DellaBitta
DellaBitta previously approved these changes Jan 13, 2021
Copy link
Contributor

@DellaBitta DellaBitta left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recall in the past some steps were failing silently.. would running cat on the summary always and then adding an if failure() clause to run exit 1 be useful?

There are cases where the summary may be useful even if errors are not detected, so this ties only the exit condition to success/failure, not the whole summary step.
@anonymous-akorn
Copy link
Contributor Author

I recall in the past some steps were failing silently.. would running cat on the summary always and then adding an if failure() clause to run exit 1 be useful?

Yeah that's better, I overlooked the possibility of checking the status within the step's logic.

@anonymous-akorn anonymous-akorn merged commit 2113051 into dev Jan 13, 2021
@anonymous-akorn anonymous-akorn deleted the feature/ak-goto-summary branch January 13, 2021 17:39
@firebase firebase locked and limited conversation to collaborators Feb 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

3 participants