cli icon indicating copy to clipboard operation
cli copied to clipboard

Git URLs in Markdown reports and diffs

Open matejchalk opened this issue 2 years ago • 1 comments

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:

  • [x] commits in report-diff.md summary and report.md About section should link to web URL of given commit (using SHA)

Report:

  • [ ] #748
    • [ ] #722
    • [x] #745

Implementation details:

  • PR1 - Models and utils
  • PR2 - IDE linking #722
  • PR3 - Github linking #745

matejchalk avatar Oct 25 '23 06:10 matejchalk

found this: https://github.com/sshaw/git-link

BioPhoton avatar Feb 01 '24 13:02 BioPhoton

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 :slightly_smiling_face:

Image Image

So this can be closed.

matejchalk avatar Jan 09 '25 12:01 matejchalk