mirror of
https://github.com/renovatebot/renovate.git
synced 2025-01-12 23:16:26 +00:00
docs: rewrite Crossplane and Argo CD manager (#25911)
This commit is contained in:
parent
8eefcbcfac
commit
0110975f16
2 changed files with 26 additions and 30 deletions
|
@ -1,9 +1,12 @@
|
||||||
The `argocd` manager has no `fileMatch` default patterns, so it won't match any files until you configure it with a pattern.
|
To use the `argocd` manager you must set your own `fileMatch` pattern.
|
||||||
This is because there is no commonly accepted file/directory naming convention for argocd YAML files and we don't want to check every single `*.yaml` file in repositories just in case any of them have ArgoCD definitions.
|
The `argocd` manager has no default `fileMatch` pattern, because there is no common filename or directory name convention for Argo CD YAML files.
|
||||||
|
By setting your own `fileMatch` Renovate avoids having to check each `*.yaml` file in a repository for a Argo CD definition.
|
||||||
|
|
||||||
If most `.yaml` files in your repository are argocd ones, then you could add this to your config:
|
If you need to change the versioning format, read the [versioning](../../../modules/versioning.md) documentation to learn more.
|
||||||
|
|
||||||
```json
|
Some configuration examples:
|
||||||
|
|
||||||
|
```json title="If most .yaml files in your repository are for Argo CD"
|
||||||
{
|
{
|
||||||
"argocd": {
|
"argocd": {
|
||||||
"fileMatch": ["\\.yaml$"]
|
"fileMatch": ["\\.yaml$"]
|
||||||
|
@ -11,9 +14,7 @@ If most `.yaml` files in your repository are argocd ones, then you could add thi
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If instead you have them all inside a `argocd/` directory, you would add this:
|
```json title="Argo CD YAML files are in a argocd/ directory"
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
{
|
||||||
"argocd": {
|
"argocd": {
|
||||||
"fileMatch": ["argocd/.+\\.yaml$"]
|
"fileMatch": ["argocd/.+\\.yaml$"]
|
||||||
|
@ -21,14 +22,10 @@ If instead you have them all inside a `argocd/` directory, you would add this:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Or if it's only a single file then something like this:
|
```json title="One Argo CD file in a directory"
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
{
|
||||||
"argocd": {
|
"argocd": {
|
||||||
"fileMatch": ["^config/applications\\.yaml$"]
|
"fileMatch": ["^config/applications\\.yaml$"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
|
||||||
|
|
|
@ -1,9 +1,20 @@
|
||||||
The `crossplane` manager has no `fileMatch` default patterns, so it won't match any files until you configure it with a pattern.
|
To use the `crossplane` manager you must set your own `fileMatch` pattern.
|
||||||
This is because there is no commonly accepted file/directory naming convention for crossplane YAML files and we don't want to check every single `*.yaml` file in repositories just in case any of them have Crossplane Packages definitions: Configurations, Providers, Functions.
|
The `crossplane` manager has no default `fileMatch` pattern, because there is no common filename or directory name convention for Crossplane YAML files.
|
||||||
|
By setting your own `fileMatch` Renovate avoids having to check each `*.yaml` file in a repository for a Crossplane Package definition.
|
||||||
|
|
||||||
If most `.yaml` files in your repository are Crossplane ones, then you could add this to your config:
|
The `crossplane` manager supports these `depType`s:
|
||||||
|
|
||||||
```json
|
- `configuration`
|
||||||
|
- `function`
|
||||||
|
- `provider`
|
||||||
|
|
||||||
|
You can use these `depType`'s to control which dependencies Renovate will upgrade.
|
||||||
|
|
||||||
|
If you need to change the versioning format, read the [versioning](../../../modules/versioning.md) documentation to learn more.
|
||||||
|
|
||||||
|
Some configuration examples:
|
||||||
|
|
||||||
|
```json title="If most .yaml files are for Crossplane"
|
||||||
{
|
{
|
||||||
"crossplane": {
|
"crossplane": {
|
||||||
"fileMatch": ["\\.yaml$"]
|
"fileMatch": ["\\.yaml$"]
|
||||||
|
@ -11,9 +22,7 @@ If most `.yaml` files in your repository are Crossplane ones, then you could add
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If instead you have them all inside a `packages/` directory, you would add this:
|
```json title="For Crossplane files in a packages/ directory"
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
{
|
||||||
"crossplane": {
|
"crossplane": {
|
||||||
"fileMatch": ["packages/.+\\.yaml$"]
|
"fileMatch": ["packages/.+\\.yaml$"]
|
||||||
|
@ -21,20 +30,10 @@ If instead you have them all inside a `packages/` directory, you would add this:
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Or if it's only a single file then something like this:
|
```json title="For a single Crossplane file"
|
||||||
|
|
||||||
```json
|
|
||||||
{
|
{
|
||||||
"crossplane": {
|
"crossplane": {
|
||||||
"fileMatch": ["^config/provider\\.yaml$"]
|
"fileMatch": ["^config/provider\\.yaml$"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
|
|
||||||
|
|
||||||
The `crossplane` manager has three `depType`s to allow a fine-grained control of which dependencies are upgraded:
|
|
||||||
|
|
||||||
- `configuration`
|
|
||||||
- `function`
|
|
||||||
- `provider`
|
|
||||||
|
|
Loading…
Reference in a new issue