scorecard icon indicating copy to clipboard operation
scorecard copied to clipboard

Feature: Suggest possible GitHub remotes when using --local

Open raghavkaul opened this issue 3 years ago • 4 comments

Is your feature request related to a problem? Please describe. As a maintainer, when cloning a GitHub repo and running scorecard against it using the flag --local=., several checks that are only possible on the GitHub repo are skipped. However, I would still like to get information about an 'all-inclusive' score, using both local and remote info.

This would be helpful particularly when working on a branch (i.e. one that intends to improve the overall scorecard score) that hasn't been pushed upstream. As a maintainer, I could see the overall score for my repo, and how my local changes would improve or worsen that score.

In cases where the local and remote contents/score of a repo differ substantially, scorecard should intelligently choose one to take precedence over the other.

Describe the solution you'd like Scorecard could use .git/config to get information about a repo's GitHub remotes, and suggest them to the user to get a more holistic score when using the --local option.

Describe alternatives you've considered

  • Scorecard could automatically pick a remote on the user's behalf instead of presenting them with the option, but users may want to augment their local scores with either a fork, or with the upstream
  • Scorecard could allow both the--local and --repo options to be specified at the same time, but this could introduce engineering complexity, since for some checks, it's not clear which would take precedence.

raghavkaul avatar Jul 14 '22 19:07 raghavkaul

See #1709. We could use go-git here to get any git-related context for local repos. Would be a helpful improvement to the tool if you'd like to tackle this.

azeemshaikh38 avatar Jul 14 '22 19:07 azeemshaikh38

This issue is stale because it has been open for 60 days with no activity.

github-actions[bot] avatar Sep 27 '23 01:09 github-actions[bot]

This issue is stale because it has been open for 60 days with no activity.

github-actions[bot] avatar Dec 15 '23 01:12 github-actions[bot]

This issue has been marked stale because it has been open for 60 days with no activity.

github-actions[bot] avatar May 04 '24 01:05 github-actions[bot]