Page MenuHomeSoftware Heritage

document GitHub caseness caveats
Closed, MigratedEdits Locked

Description

GitHub repository URLs have a canonical case-normalized form, but most GitHub services treat them as case-insensitive, e.g.: https://github.com/BIC-MNI/mni_autoreg (canonical version) v. https://github.com/bic-mni/mni_autoreg v. https://github.com/BiC-MnI/MnI_AuToReG .

In Software Heritage, we have origin URLs that are case sensitive, and for GitHub we use canonical URLs obtained via GitHub repository API.

We need to document, as a FAQ of sort, how users of our API can find the canonical form of GitHub URLs to lookup visits in the Software Heritage archive. The GitHub API allows to retrieve the canonical name:

$ curl -s https://api.github.com/repos/BiC-MnI/MnI_AuToReG | grep full_name
  "full_name": "BIC-MNI/mni_autoreg",