Skip to content
Snippets Groups Projects
Unverified Commit fe37570d authored by mptr's avatar mptr Committed by mptr
Browse files

docs: add renovate section

parent f96ec737
No related branches found
No related tags found
No related merge requests found
......@@ -280,6 +280,54 @@ However, we cannot use the alternative `+` which would indicate build metadata
as we'd like.
See https://github.com/distribution/distribution/issues/1201*
### Using with Renovate
To keep the component versions up to date you could use [Renovate](https://docs.renovatebot.com/).
Renovate users who use the component input `opentofu_version` should include the following `extends`
so that the OpenTofu version is raised to a maximum of the version suitable for the component:
```json
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["local>components/opentofu"],
...
}
```
(You may need to adjust the path to the `components/opentofu` to match your mirror.)
Fore more details refer to the [Renovate documentation](https://docs.renovatebot.com/config-presets/).
Some more example configurations for your `renovate.json`:
- Package Rule to update all CI-Components
```json
{
"matchFileNames": [
".gitlab-ci.yaml",
".gitlab-ci.yml",
"templates/**/*.yaml",
"templates/**/*.yml"
],
"groupName": "Pipeline",
"semanticCommitType": "ci",
"automerge": true
},
```
- Package rule to pin only `major.minor` versions:
```json
{
"matchManagers": ["gitlabci"],
"extractVersion": "^(?<version>\\d+\\.\\d+)"
},
```
- Package rule to target a specific component:
```json
{
"matchPackageNames": ["components/opentofu"],
"matchManagers": ["gitlabci"]
},
```
## Usage on self-managed
GitLab CI/CD components are not yet distributed and available on self-managed GitLab instances.
......
......@@ -297,6 +297,54 @@ However, we cannot use the alternative `+` which would indicate build metadata
as we'd like.
See https://github.com/distribution/distribution/issues/1201*
### Using with Renovate
To keep the component versions up to date you could use [Renovate](https://docs.renovatebot.com/).
Renovate users who use the component input `opentofu_version` should include the following `extends`
so that the OpenTofu version is raised to a maximum of the version suitable for the component:
```json
{
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
"extends": ["local>components/opentofu"],
...
}
```
(You may need to adjust the path to the `components/opentofu` to match your mirror.)
Fore more details refer to the [Renovate documentation](https://docs.renovatebot.com/config-presets/).
Some more example configurations for your `renovate.json`:
- Package Rule to update all CI-Components
```json
{
"matchFileNames": [
".gitlab-ci.yaml",
".gitlab-ci.yml",
"templates/**/*.yaml",
"templates/**/*.yml"
],
"groupName": "Pipeline",
"semanticCommitType": "ci",
"automerge": true
},
```
- Package rule to pin only `major.minor` versions:
```json
{
"matchManagers": ["gitlabci"],
"extractVersion": "^(?<version>\\d+\\.\\d+)"
},
```
- Package rule to target a specific component:
```json
{
"matchPackageNames": ["components/opentofu"],
"matchManagers": ["gitlabci"]
},
```
## Usage on self-managed
GitLab CI/CD components are not yet distributed and available on self-managed GitLab instances.
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment