Repository navigation
Git URLs in Markdown reports and diffs #149
Description
The CLI need can improve in UX when we link the report source file issues to the related file. If we click the link alter we should either open up the file locally in our IDE or jump to the github repository, depending on the usage.
This issue is a follow-up to #148
Comparison Report:
- commits in
report-diff.mdsummary andreport.mdAbout section should link to web URL of given commit (using SHA)
Report:
Implementation details:
- PR1 - Models and utils
- PR2 - IDE linking Issues sections should link to Git URL of file at given commit with highlighted line(s) #722
- PR3 - Github linking Issues sections should link to local file in your IDE at given commit with highlighted line(s) #745
Activity
BioPhoton commentedon Feb 1, 2024
found this:
https://github.com/sshaw/git-link
[-]Git URLs in report.md[/-][+]Git URLs in Markdown reports and diffs[/+]matejchalk commentedon Jan 9, 2025
The file links were already implemented by @hanna-skryl in #824 and #840.
For the commit links, it turns out no logic is needed on our end, because both GitHub and GitLab autolink commit SHAs in markdown comments 🙂
So this can be closed.