Skip to content

update readme for (gitlab) config #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Dec 1, 2017
Merged

update readme for (gitlab) config #99

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
347c2c6
update readme for (gitlab) config
paulirish Oct 27, 2017
e159276
local->optional global
paulirish Dec 1, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 15 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,27 +101,28 @@ 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 |
| ------------------------- | ---------------- |
| 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`) |

| 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 |

```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]
git config [--global] open.[gitdomain].domain [value]
git config [--global] open.[gitdomain].protocol [value]
```

If your Gitlab custom hosted is serving `http` you can also specify this:
**Example**
* Your git remote is at `ssh://git@git.internal.biz:7000/XXX/YYY.git`
* Your hosted gitlab is `http://repo.intranet/subpath/XXX/YYY`

```sh
# use --global to set across all repos, instead of just the local one
git config [--global] gitopen.gitlab.protocol http
git config [--global] "open.https://git.internal.biz.domain" "repo.intranet/subpath"
git config [--global] "open.https://git.internal.biz.protocol" "http"
```

## Alternative projects
Expand Down
2 changes: 0 additions & 2 deletions test/git-open.bats
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,15 +240,13 @@ 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"
}

@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"
Expand Down