Report issue in job summary when build scan can't be published

[3flex]

At the end of this job, message in the log is:

A build scan was not published as you have not authenticated with server 'ge.detekt.dev'.

So the link the link in https://github.com/detekt/detekt/actions/runs/2481482476 doesn't work, because there's no build scan to link to, but it's unclear from the job summary what the underlying problem is unless you try clicking the link.

Perhaps splitting the table into a success/failure message, and then having another column for build scan link (or the failure message, such as in this case when the build configuration is incorrect and the build scan wasn't published) would highlight the issue more prominently.

[bigdaz]

Just proposing some visual options for feedback.

Here is the current summary:

Root Project	Tasks	Gradle Version	Outcome
passing-build	with-build-scan	7.4.2
failing-build	with-build-scan	7.4.2
passing-build	no-build-scan	7.4.2
failing-build	no-build-scan	7.4.2
passing-build	build-scan-publish-failed	7.4.2

And here's a possible improvement:

Root Project	Tasks	Gradle Version	Outcome	Build Scan™
passing-build	with-build-scan	7.4.2	✅
failing-build	with-build-scan	7.4.2	❌
passing-build	no-build-scan	7.4.2	✅
failing-build	no-build-scan	7.4.2	❌
passing-build	build-scan-publish-failed	7.4.2	✅

And here's a possible improvement:

Root Project	Tasks	Gradle Version	Outcome	Build Scan™
passing-build	with-build-scan	7.4.2	✅
failing-build	with-build-scan	7.4.2	❌
passing-build	no-build-scan	7.4.2	✅
failing-build	no-build-scan	7.4.2	❌
passing-build	build-scan-publish-failed	7.4.2	✅

Note that in the case where none of the builds generate a build scan, we could potentially remove the "Build Scan" column altogether.

[runningcode]

I like that the third options distinguishes the color of the build scan publication from the build success failure. I think that using the same colors can be confusing. Perhaps the "publish failed" could be orange instead of red to further distinguish it?

Other than that, my preference is for the third option.

[clayburn]

I also like the third option.

Question: What will the badge link to in the "Not Published" and "Publish Failed" cases?

[bigdaz]

What will the badge link to in the "Not Published" and "Publish Failed" cases?

@clayburn I was thinking the "Not Published" and "Publish Failed" badges could link to appropriate documentation.

[alextu]

A bit like @runningcode said, I'd say a mix of 2nd and 3rd option ie regarding the build scan column:

• "published" Blue badge when build scan is published, whether build is failing or not
• "publish failed" Gray badge when build scan publication failed
• No badge when build scan is not published (or if we want to have a badge, the "not published" Gray badge)

[bigdaz]

Thanks all for the feedback. This is what we have now, with colours and links improved: https://github.com/gradle/gradle-build-action/actions/runs/2524639182#summary-6956411171

I'm happy to do another round of polishing, but I plan to release this as v2.2.1 pretty soon.

[3flex]

I think that looks great, thank you for taking the feedback on board!