utils-code/paulirish.git-open
1
0
Fork 0
mirror of https://github.com/paulirish/git-open.git synced 2026-09-10 07:26:15 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

update readme for (gitlab) config

Browse source
This commit is contained in:
Paul Irish 2017-10-27 15:19:58 -07:00
parent 07d75b2e1e
commit 347c2c6b52
2 changed files with 15 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
README.md
View file

@ -101,27 +101,25 @@ git-open can automatically guess the corresponding repository page for remotes
- bitbucket.org
- Atlassian Bitbucket Server (formerly _Atlassian Stash_)
### GitLab support
### Configuration (GitLab support)
To configure GitLab support you need to set some options.
To configure GitLab support (or other unique hosting situations) you need to set some options.
| option name | description | example |
| ------------------------- | ---------------------------------------------------------- | ------------------ |
| gitopen.gitlab.domain | The (web)domain name that will work for most of the people | gitlab.example.com |
| gitopen.gitlab.ssh.domain | A specific ssh domain name, *if needed* | git.example.com |
| gitopen.gitlab.ssh.port | A specific ssh port, *if needed* | 10022 |
| option name | description |
| ------------------------- | ---------------- |
| open.[gitdomain].domain | The (web) domain to open based on the provided git repo domain |
| open.[gitdomain].protocol | The (web) protocol to open based on the provided git repo domain. (Defaults to `https`) |
<!--
git config --local --add open.[gitdomain].domain [value]
git config --local --add open.[gitdomain].protocol [value]
-->
```sh
# use --global to set across all repos, instead of just the local one
git config [--global] gitopen.gitlab.domain [value]
git config [--global] gitopen.gitlab.ssh.domain [value]
git config [--global] gitopen.gitlab.ssh.port [value]
```
If your Gitlab custom hosted is serving `http` you can also specify this:
```sh
# use --global to set across all repos, instead of just the local one
git config [--global] gitopen.gitlab.protocol http
# Your git remote is at "ssh://git@git.internal.biz:7000/XXX/YYY.git"
# Your hosted gitlab is "http://repo.intranet/subpath/XXX/YYY"
git config --local --add "open.https://git.internal.biz.domain" "repo.intranet/subpath"
git config --local --add "open.https://git.internal.biz.protocol" "http"
```
## Alternative projects

2
test/git-open.bats
View file

@ -240,7 +240,6 @@ setup() {
@test "gitlab: default ssh origin style" {
# https://github.com/paulirish/git-open/pull/55
git remote set-url origin "git@gitlab.example.com:user/repo"
git config "gitopen.gitlab.domain" "gitlab.example.com"
run ../git-open
assert_output "https://gitlab.example.com/user/repo"
}
@ -248,7 +247,6 @@ setup() {
@test "gitlab: ssh://git@ origin" {
# https://github.com/paulirish/git-open/pull/51
git remote set-url origin "ssh://git@gitlab.domain.com/user/repo"
git config "gitopen.gitlab.domain" "gitlab.domain.com"
run ../git-open
assert_output "https://gitlab.domain.com/user/repo"
refute_output --partial "//user"