Skip to content

Made check symbol for cancelled uniform across commands#4850

Merged
mislav merged 2 commits intocli:trunkfrom
bchadwic:cancelled-symbol-fix
Dec 16, 2021
Merged

Made check symbol for cancelled uniform across commands#4850
mislav merged 2 commits intocli:trunkfrom
bchadwic:cancelled-symbol-fix

Conversation

@bchadwic
Copy link
Contributor

@bchadwic bchadwic commented Dec 3, 2021

Mentioned in #4090

Meant to get to this a while ago, the CANCELLED status for a check is either a X or a -, depending on what command you use.

With this pr, regardless of the command, - is the symbol for checks with a CANCELLED status

@bchadwic bchadwic requested a review from a team as a code owner December 3, 2021 19:04
@bchadwic bchadwic requested review from mislav and removed request for a team December 3, 2021 19:04
@cliAutomation cliAutomation added the external pull request originating outside of the CLI core team label Dec 3, 2021
@darcyclarke
Copy link

@bchadwic Hey! We discussed this in a triage call & think that the existing categorization actually makes a bit more sense given that a "CANCELLED" workflow/action results in a failure for PRs. Going to close this for now unless you feel strongly otherwise & we can reopen discussion or try to find a nuanced way to display cancellations vs. failures.

@mislav
Copy link
Contributor

mislav commented Dec 15, 2021

@bchadwic I realize that our decision here kind of overrides the suggestion you got in #4090 (review), but we've thought this through and concluded that as long as "cancelled" counts as a failure on the platform, we're much more comfortable with it being rendered and reported as a failure rather than it being rendered and counted together with neutral statuses like "skipped".

Instead, would you be open to changing gh run so it renders cancelled status as "X"?

@bchadwic
Copy link
Contributor Author

Instead, would you be open to changing gh run so it renders cancelled status as "X"?

Yeah, definitely! Making the checks uniform was my main concern, whether "cancelled" is "X" or "-" doesn't bother me a bit.

Out of curiosity though, what scenario does "cancelled" happen? Is it user driven or something on the backend?

Also, @darcyclarke, can we open this pr back up with the intent to change gh run instead now? Thank you.

@mislav
Copy link
Contributor

mislav commented Dec 15, 2021

Workflow runs may be cancelled via the API, via the web UI while a workflow is running, or by the Actions infrastructure itself (by default, one failed job in a matrix will auto-cancel all other running jobs in that matrix).

@mislav mislav reopened this Dec 15, 2021
Copy link
Contributor

@mislav mislav left a comment

Choose a reason for hiding this comment

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

Note that this UI change comes with a behavior change: a "cancelled" job will make gh pr checks return a nonzero exit status. I'm fine with this, as I see it that "cancelled" being a neutral status before was a bug.

@mislav mislav merged commit 3ea69c8 into cli:trunk Dec 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

external pull request originating outside of the CLI core team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants