Skip to content
This repository has been archived by the owner on Jul 2, 2024. It is now read-only.

EVG-19254: Show details.description regardless of task status #2070

Merged
merged 5 commits into from
Oct 2, 2023

Conversation

minnakt
Copy link
Contributor

@minnakt minnakt commented Sep 28, 2023

EVG-19254

Description

Users can set the value of description even if the task has succeeded (docs), but we only show it if the task has failed. We should show the description if it exists.

I wasn't sure what verbiage to use since description can be set to anything of the user's choice (or it will default to the last run command), so if you have another suggestion feel free to let me know.

Testing

  • Jest test
  • Manually testing using the example link from the ticket

@cypress
Copy link

cypress bot commented Sep 28, 2023

Passing run #13004 ↗︎

0 595 7 0 Flakiness 0

Details:

Order props alphabetically
Project: Spruce Commit: 2d4418cad5
Status: Passed Duration: 18:18 💡
Started: Oct 2, 2023 2:59 PM Ended: Oct 2, 2023 3:17 PM

Review all test suite changes for PR #2070 ↗︎

@minnakt minnakt changed the title EVG-19254: Show details.desc regardless of task status EVG-19254: Show details.description regardless of task status Sep 28, 2023
@minnakt minnakt marked this pull request as ready for review September 28, 2023 14:59
@minnakt minnakt requested a review from a team September 28, 2023 14:59
details.description,
isContainerTask
)}`
: `Command: ${details.description}`}
Copy link
Contributor

Choose a reason for hiding this comment

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

The character limit is 500 according to the docs. I think the text needs to render outside of the metadata panel after a certain character count.

details.description,
isContainerTask
)}`
: `Command: ${details.description}`}
Copy link
Contributor

Choose a reason for hiding this comment

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

A possible label is "Status description". It could be good since those words are similar to the docs and API.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

thanks for the suggestion — but I think I might like Command slightly more. 😅

Copy link
Contributor

Choose a reason for hiding this comment

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

No problem Command is good too 😎

@minnakt minnakt requested a review from SupaJoon September 30, 2023 00:00
@minnakt minnakt merged commit da4a6de into evergreen-ci:main Oct 2, 2023
2 checks passed
@minnakt minnakt deleted the EVG-19254 branch October 2, 2023 16:10
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants