Skip to content

Commit

Permalink
Update README: clarify running command
Browse files Browse the repository at this point in the history
  • Loading branch information
alexandear committed Jun 12, 2023
1 parent cb955ff commit 672fcba
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,14 +21,15 @@ export GITLAB_TOKEN=<your_gitlab_token>
export COMMITTER_NAME="<Name Surname>"
export COMMITTER_EMAIL=<[email protected]>

import-gitlab-commits
$(go env GOPATH)/bin/import-gitlab-commits
```

where
- `GITLAB_BASE_URL` is a GitLab [instance URL](https://stackoverflow.com/questions/58236175/what-is-a-gitlab-instance-url-and-how-can-i-get-it), e.g. `https://gitlab.com`, `https://gitlab.gnome.org` or any GitLab server;
- `GITLAB_TOKEN` is a personal [access token](https://docs.gitlab.com/ee/user/profile/personal_access_tokens.html#create-a-personal-access-token);
- `COMMITTER_NAME` is your GitHub name with surname, e.g. `John Doe` (can be passed to `git config user.name`);
- `COMMITTER_EMAIL` is your GitHub email, e.g. `[email protected]` (valid for `git config user.email`).
- `COMMITTER_EMAIL` is your GitHub email, e.g. `[email protected]` (valid for `git config user.email`);
- `$(go env GOPATH)/bin/` is the path where `import-gitlab-commits` installed.

## Example

Expand Down

0 comments on commit 672fcba

Please sign in to comment.