Skip to content

Commit 3fd8607

Browse files
committed
Document GitLab support
1 parent dda71c5 commit 3fd8607

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

content/_index.en.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -326,17 +326,18 @@ The default configuration can be found in `config/default.json`. The full refere
326326
}
327327
},
328328
"reporter": { // Reporter mechanism to create GitHub issues when terms content is inaccessible
329-
"githubIssues": {
330-
"repositories": {
331-
"declarations": "GitHub repository where to create issues; expected format: <owner>/<repository>",
332-
"versions": "GitHub repository of versions associated with the declarations; expected format: <owner>/<repository>",
333-
"snapshots": "GitHub repository of snapshots associated with the declarations; expected format: <owner>/<repository>"
334-
}
329+
"type": "The type of reporter to use; can be 'github' or 'gitlab'",
330+
"repositories": {
331+
"declarations": "GitHub or GitLab repository where to create issues; expected format: <owner>/<repository>",
332+
"versions": "GitHub or GitLab repository of versions associated with the declarations; expected format: <owner>/<repository>",
333+
"snapshots": "GitHub or GitLab repository of snapshots associated with the declarations; expected format: <owner>/<repository>"
335334
}
335+
"baseURL": "Base URL of the GitLab instance (only relevant if 'type' is 'gitlab')",
336+
"apiBaseURL": "Base URL of the GitLab API (only relevant if 'type' is 'gitlab')"
336337
},
337338
"dataset": { // Release mechanism to create dataset periodically
338339
"title": "Title of the dataset; recommended to be the name of the instance that generated it",
339-
"versionsRepositoryURL": "GitHub repository where the dataset will be published as a release; recommended to be the versions repository for discoverability and tagging purposes",
340+
"versionsRepositoryURL": "GitHub or GitLab repository where the dataset will be published as a release; recommended to be the versions repository for discoverability and tagging purposes",
340341
"publishingSchedule": "Cron expression to define the dataset publishing schedule; see below"
341342
},
342343
"collection-api": { // Collection metadata API
@@ -410,7 +411,11 @@ Environment variables can be passed in the command-line or provided in a `.env`
410411

411412
- `OTA_ENGINE_SMTP_PASSWORD`: a password for email server authentication, in order to send email notifications.
412413
- `OTA_ENGINE_SENDINBLUE_API_KEY`: a SendInBlue API key, in order to send email notifications with that service.
413-
- `OTA_ENGINE_GITHUB_TOKEN`: a token with repository privileges to access the [GitHub API](https://github.com/settings/tokens).
414+
- `OTA_ENGINE_GITHUB_TOKEN`: a token with repository privileges to access the [GitHub API](https://github.com/settings/tokens) to create issues and publish dataset releases.
415+
- `OTA_ENGINE_GITLAB_TOKEN`: a token with repository privileges to access the [GitLab API](https://gitlab.com/profile/personal_access_tokens) to create issues.
416+
- `OTA_ENGINE_GITLAB_RELEASES_TOKEN`: a token with repository privileges to access the [GitLab API](https://gitlab.com/profile/personal_access_tokens) to publish dataset releases.
417+
418+
If both `OTA_ENGINE_GITHUB_TOKEN` and `OTA_ENGINE_GITLAB_TOKEN` are defined, GitHub takes precedence for dataset publishing.
414419

415420
If an outgoing HTTP/HTTPS proxy to access the Internet is required, it is possible to provide it through the `HTTP_PROXY` and `HTTPS_PROXY` environment variable.
416421

0 commit comments

Comments
 (0)