Skip to content

Document GitLab support #147

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
Nov 21, 2024
Merged

Document GitLab support #147

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3fd8607
Document GitLab support
Ndpnt Nov 12, 2024
df46430
Add missing configuration key documentation
Ndpnt Nov 13, 2024
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
24 changes: 15 additions & 9 deletions content/_index.en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -326,18 +326,20 @@ The default configuration can be found in `config/default.json`. The full refere
}
},
"reporter": { // Reporter mechanism to create GitHub issues when terms content is inaccessible
"githubIssues": {
"repositories": {
"declarations": "GitHub repository where to create issues; expected format: <owner>/<repository>",
"versions": "GitHub repository of versions associated with the declarations; expected format: <owner>/<repository>",
"snapshots": "GitHub repository of snapshots associated with the declarations; expected format: <owner>/<repository>"
}
"type": "The type of reporter to use; can be 'github' or 'gitlab'",
"repositories": {
"declarations": "GitHub or GitLab repository where to create issues; expected format: <owner>/<repository>",
"versions": "GitHub or GitLab repository of versions associated with the declarations; expected format: <owner>/<repository>",
"snapshots": "GitHub or GitLab repository of snapshots associated with the declarations; expected format: <owner>/<repository>"
}
"baseURL": "Base URL of the GitLab instance (only relevant if 'type' is 'gitlab')",
"apiBaseURL": "Base URL of the GitLab API (only relevant if 'type' is 'gitlab')"
},
"dataset": { // Release mechanism to create dataset periodically
"title": "Title of the dataset; recommended to be the name of the instance that generated it",
"versionsRepositoryURL": "GitHub repository where the dataset will be published as a release; recommended to be the versions repository for discoverability and tagging purposes",
"publishingSchedule": "Cron expression to define the dataset publishing schedule; see below"
"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",
"publishingSchedule": "Cron expression to define the dataset publishing schedule; see below",
"apiBaseURL": "Base URL of the GitLab API (only relevant if 'type' is 'gitlab')"
},
"collection-api": { // Collection metadata API
"port": "The port number on which the API will listen for incoming requests",
Expand Down Expand Up @@ -410,7 +412,11 @@ Environment variables can be passed in the command-line or provided in a `.env`

- `OTA_ENGINE_SMTP_PASSWORD`: a password for email server authentication, in order to send email notifications.
- `OTA_ENGINE_SENDINBLUE_API_KEY`: a SendInBlue API key, in order to send email notifications with that service.
- `OTA_ENGINE_GITHUB_TOKEN`: a token with repository privileges to access the [GitHub API](https://github.com/settings/tokens).
- `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.
- `OTA_ENGINE_GITLAB_TOKEN`: a token with repository privileges to access the [GitLab API](https://gitlab.com/profile/personal_access_tokens) to create issues.
- `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.

If both `OTA_ENGINE_GITHUB_TOKEN` and `OTA_ENGINE_GITLAB_TOKEN` are defined, GitHub takes precedence for dataset publishing.

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.

Expand Down
Loading