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

✨ Issues table: Add description column, render expanded description as markdown, render links under markdown in table and incident viewer, add alert text to all incidents tab #1116

Merged
merged 6 commits into from
Jul 12, 2023

Conversation

mturley
Copy link
Collaborator

@mturley mturley commented Jul 11, 2023

This PR contains four presentation tweaks to the Issues page from recent discussions:

  1. From a recent email discussion, it was decided that the although the issue description can be long, the first line of it is the most meaningful "title" for an issue or issue-based report and it should be included in the table. This change adds the first line of the description to the table, truncated with a tooltip.
  2. The issue description in the expanded row content was being rendered in plain text, and now its value can contain markdown. This change wraps it using ReactMarkdown like the incident message.
  3. The issue object (and now the issue-related reports as of ✨ Add links to rules and issues reports. tackle2-hub#434) contains a links array that we were not rendering. This change adds external links for these URLs under the issue description in the expanded rows of the issues table, and under the incident message in the incident viewer modal.
  4. There was a placeholder TODO string in the info alert above the "all incidents" table in the incident viewer modal. This change adds a first pass of that message: "Full details are only available for the first 5 incidents per file due to performance constraints". We can revisit this if there are any objections to this text.

Signed-off-by: Mike Turley <mike.turley@alum.cs.umass.edu>
Signed-off-by: Mike Turley <mike.turley@alum.cs.umass.edu>
@codecov
Copy link

codecov bot commented Jul 11, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (aedaf9c) 44.08% compared to head (3714bef) 44.08%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1116   +/-   ##
=======================================
  Coverage   44.08%   44.08%           
=======================================
  Files         177      177           
  Lines        4498     4498           
  Branches     1007     1007           
=======================================
  Hits         1983     1983           
  Misses       2504     2504           
  Partials       11       11           
Flag Coverage Δ
unitests 44.08% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

Signed-off-by: Mike Turley <mike.turley@alum.cs.umass.edu>
Signed-off-by: Mike Turley <mike.turley@alum.cs.umass.edu>
@mturley mturley changed the title ✨ Issues table: Add description column, render expanded description as markdown, render links under markdown in table and incident viewer ✨ Issues table: Add description column, render expanded description as markdown, render links under markdown in table and incident viewer, add alert text to all incidents tab Jul 11, 2023
Copy link
Member

@ibolton336 ibolton336 left a comment

Choose a reason for hiding this comment

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

LGTM!

ibolton336 and others added 2 commits July 12, 2023 12:39
Signed-off-by: Mike Turley <mike.turley@alum.cs.umass.edu>
@mturley mturley merged commit 9413509 into konveyor:main Jul 12, 2023
7 checks passed
@mturley mturley deleted the render-issue-links branch July 12, 2023 17:21
mturley added a commit that referenced this pull request Jul 21, 2023
…ing issue name (#1186)

Followup to #1116

When we replaced the issue name property (possibly empty in real data)
with the truncated issue description in the table, we failed to replace
it everywhere else it is used.

This change uses the first line of the issue/report description where
necessary, and truncates it with a tooltip in places with limited
available width in case it is a long line.

---------

Signed-off-by: Mike Turley <mike.turley@alum.cs.umass.edu>
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.

2 participants