Supports public and private git repos when using shorted repo syntax #2992
Conversation
thedumbterminal
changed the title
|
@bestander any thoughts on the approach taken here? |
|
so far looks reasonable, go on :) |
|
Cheers will finish this up hopefully in the week. |
| const fragment: ExplodedFragment = { | ||
| user: 'foo', | ||
| repo: 'bar', | ||
| hash: '', | ||
| }; | ||
|
|
||
| const expected = 'git+ssh://[email protected]/' + fragment.user + '/' + fragment.repo + '.git'; | ||
| expect(GitHubResolver.getGitSSHUrl(fragment)).toBe(expected); |
There was a problem hiding this comment.
Previously the getGitHTTPUrl test was actaully running getGitSSHUrl instead!
| const fragment: ExplodedFragment = { | ||
| user: 'foo', | ||
| repo: 'bar', | ||
| hash: '', | ||
| }; | ||
|
|
||
| const expected = 'git+ssh://[email protected]/' + fragment.user + '/' + fragment.repo + '.git'; | ||
| expect(GitLabResolver.getGitSSHUrl(fragment)).toBe(expected); |
There was a problem hiding this comment.
Previously the getGitHTTPUrl test was actaully running getGitSSHUrl instead!
|
CI seems to be failing on random tests unrelated to my changes, this work is now ready for someone to review. |
|
Awesome work, @thedumbterminal! |
|
Just tried it and it doesn't work (github repo shorthand with private repo); it prompted me to enter my ssh key's passphrase but I cannot actually enter anything at all. |
|
@gsklee You need to make sure you have your ssh key setup in your terminal first, if you are using linux or mac osx then you can run: Then try running the yarn command again. |
Summary
When using the shortened git syntax such as
github:thedumbterminal/grunt-gemnasium#vx, yarn tests for HTTP access using a generated URL ending in.gitthis will always return a301status even if the user does not have permission to access the repo (private repos would require auth first).This change now uses a full git URL which does not end in
.gitthis means that private repos will fail with404so then SSH auth is attempted instead, as long as the correct SSH keys are setup in the users terminal access to the private repo will succeed.Addresses existing issue: #2774
Test plan
Added new unit tests for the new
getGitHTTPBaseUrlmethod.This can be manually tested in the following way:
mkdir /tmp/example; cd /tmp/example; npm init -y"grunt-gemnasium": "github:thedumbterminal/grunt-gemnasium#v1.1.1"yarn --verbose, both modules should be installed.