Make Sigrid CI feedback more visually appealing.

[dennis-sig]

Multiple people have told us that the Sigrid CI comments are a bit too large vertically. We made several changes based on this feedback:

• If there are more than 8 refactoring candidates, we limit the list and just show "…and 8 more". Showing every single refactoring candidate for large files becomes overwhelming.
• For the remaining/unchanged technical debt, we remove the list altogether and instead have a link to Sigrid. This list can be really long if your system has a lot of technical debt, so this is best explored with the Sigrid UI since such a long list is not browsable.
• We put all the details beyond the conclusion in <summary>/<details> block. Unfortunately not every platform supports this, as they all have slightly different flavors of Markdown. To account for this, we'll only add these constructs if we know the platform supports them.
• Put the Sigrid link in the title, instead of having to hunt for it all the way down.
• Duplication refactoring candidates were extremely verbose if there are many duplicate occurrences, this is now displayed a bit more elegantly.
• Some general UX tweaks by Yu.

[github-actions]

Sigrid maintainability feedback

✅ You wrote maintainable code and achieved your Sigrid objective of 3.5 stars

Show details

Sigrid compared your code against the baseline of 2024-11-06.

👍 What went well?

You fixed or improved 0 refactoring candidates.

👎 What could be better?

Unfortunately, 4 refactoring candidates were introduced or got worse.

Risk	System property	Location
🟡	Unit Size (Introduced)	src/markdown_report.py MarkdownReport.renderRefactoringCandidates(feedback,sigridLink)
🟡	Unit Size (Worsened)	src/markdown_report.py MarkdownReport.renderMarkdown(analysisId,feedback,options)
🟡	Unit Size (Introduced)	src/markdown_report.py MarkdownReport.renderRefactoringCandidatesTable(refactoringCandidates)
🟡	Unit Interfacing (Worsened)	src/markdown_report.py MarkdownReport.renderMarkdown(analysisId,feedback,options)

📚 Remaining technical debt

1 refactoring candidates didn't get better or worse, but are still present in the code you touched.

View this system in Sigrid** to explore your technical debt

⭐️ Sigrid ratings

System property	System on 2024-11-06	Before changes	New/changed code
Volume	5.5	N/A	N/A
Duplication	5.5	5.5	5.5
Unit Size	4.4	3.1	2.7
Unit Complexity	4.0	5.5	5.5
Unit Interfacing	2.2	1.7	2.0
Module Coupling	3.2	N/A	5.5
Component Independence	N/A	N/A	N/A
Component Entanglement	N/A	N/A	N/A
Maintainability	4.1	4.4	4.6

---

Did you find this feedback helpful?

We would like to know your thoughts to make Sigrid better.
Your username will remain confidential throughout the process.

• ✅ Yes, these findings are useful
• 🔸 The findings are false positives
• 🔹 These findings are not so important to me

---

View this system in Sigrid