Skip to content

Auto expanded summary quick view using markdown on issuables

Stanislav Dobrovolschii requested to merge feature/386937-expanded-summary-quick-view into master

What does this MR do and why?

MR adds support for the new +s markdown notation for the Epic, Issue and Merge Request entities. The new +s (summary) notation extends existing + format by providing additional info on assignees, milestone and health status of referenced issuable. The new suffix (+s) was added to all issuables, but is fully visible only when referencing an issue, partially visible (assignees + milestone) with MRs and not visible with epics (as epics don't have any of the summary fields).

Summary text template

#{Issuable title} (#{Issuable reference}) #{Assignees names} #{Milestone title} #{Health status}

Edge-cases

  • #{Assignees names} is replaced with Unassigned when there are no assignees
  • #{Assignees names} becomes #{Assignee name 1}, #{Assignee name 2}+ when issuable has more than 2 assignees
  • #{Milestone title} part is skipped when issuable doesn't have a milestone
  • #{Health status} part is skipped when health status isn't set

Screenshots or screen recordings

Before before
After after_with_divider

How to set up and validate locally

  1. Open local issue (issue path example /gitlab-org/gitlab-shell/-/issues/6)
  2. Update description with following table 👇
Table with references 
| Type | Regular link | `+` | `+s` |
| ------ | ------ | ------ | ------ |
| Epic | &1 | &1+ | &1+s |
| Issue | #1 | #1+ | #1+s |
| MR | !1 | !1+ | !1+s |

MR acceptance checklist

This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability.

Related to #386937 (closed)

Edited by Stanislav Dobrovolschii

Merge request reports