Skip to content

Commit 307a523

Browse files
authored
Added note to supply SSH Urls when using private keys (#139)
1 parent 0eea0b7 commit 307a523

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

content/en/docs/cluster/private-repositories.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,22 @@ python3 runner.py \
116116
--filename usage_scenario.yml \
117117
--ssh-private-key ~/.ssh/id_ed25519
118118
```
119+
120+
## Use the SSH URL, not the HTTPS URL
121+
122+
{{< callout context="caution" icon="outline/alert-triangle" >}}
123+
When measuring a private repository you **must** supply the SSH URL (`git@github.com:owner/repo.git`), not the HTTPS URL (`https://github.com/owner/repo`). The SSH key configured in your settings is only used by the Git clone step; the HTTPS URL bypasses it and will fail with a "Could not find repository" error because the repository is not publicly accessible over HTTPS.
124+
{{< /callout >}}
125+
126+
| Correct (SSH URL) | Wrong (HTTPS URL) |
127+
|---|---|
128+
| `git@github.com:myorg/myrepo.git` | `https://github.com/myorg/myrepo` |
129+
| `git@gitlab.com:myorg/myrepo.git` | `https://gitlab.com/myorg/myrepo` |
130+
131+
You can copy the SSH URL from the repository's clone dialog on GitHub or GitLab by switching to the **SSH** tab.
132+
133+
## Troubleshooting
134+
135+
- **Error: "Could not find repository … Is the repo publicly accessible, not empty and does the branch … exist?"**
136+
137+
This error appears when GMT cannot access the repository through the public API. The most common cause when using private repositories is supplying the HTTPS URL instead of the SSH URL. Switch to the SSH URL format (`git@github.com:owner/repo.git`) and retry.

0 commit comments

Comments
 (0)