renovate/lib/modules/datasource/gitlab-releases/readme.md

42 lines
1.9 KiB
Markdown

[GitLab Releases API](https://docs.gitlab.com/ee/api/releases/) supports looking up [releases supported by GitLab](https://docs.gitlab.com/ee/user/project/releases/) and can be used in combination with [regex managers](../../manager/regex/index.md) to keep dependencies up-to-date which are not specifically supported by Renovate.
To specify which specific repository should be queried when looking up a package, the `packageName` should be set to the project path.
As an example, `gitlab-org/ci-cd/package-stage/feature-testing/new-packages-list` would look for releases in the `gitlab-org/ci-cd/package-stage/feature-testing/new-packages-list` project.
To specify where to find a self-hosted GitLab instance, specify `registryUrl`.
An example would be `https://gitlab.company.com`.
Please note the following requirements:
- This datasource requires at least GitLab 11.7
**Usage Example**
A real-world example for this specific datasource would be maintaining package versions in a config file.
This can be achieved by configuring a custom manager in `renovate.json` for files named `versions.ini`:
```json
{
"customManagers": [
{
"customType": "regex",
"fileMatch": ["^versions.ini$"],
"matchStrings": [
"# renovate: datasource=(?<datasource>.*?) depName=(?<depName>.*?)( versioning=(?<versioning>.*?))?( registryUrl=(?<registryUrl>.*?))?\\s.*?_VERSION=(?<currentValue>.*)\\s"
],
"versioningTemplate": "{{#if versioning}}{{{versioning}}}{{else}}semver{{/if}}"
}
]
}
```
Now you may use comments in your `versions.ini` files to automatically update dependencies, which could look like this:
```ini
# renovate: datasource=gitlab-releases depName=gitlab-org/ci-cd/package-stage/feature-testing/new-packages-list versioning=semver registryUrl=https://gitlab.com
NKJS_VERSION=3.4.0
```
By default, `gitlab-releases` uses the `semver-coerced` versioning scheme.