Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: rewrite Crossplane and Argo CD manager (#25911)
- Loading branch information
1 parent
8eefcbc
commit 0110975
Showing
2 changed files
with
26 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,34 +1,31 @@ | ||
The `argocd` manager has no `fileMatch` default patterns, so it won't match any files until you configure it with a 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. | ||
To use the `argocd` manager you must set your own `fileMatch` pattern. | ||
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": { | ||
"fileMatch": ["\\.yaml$"] | ||
} | ||
} | ||
``` | ||
|
||
If instead you have them all inside a `argocd/` directory, you would add this: | ||
|
||
```json | ||
```json title="Argo CD YAML files are in a argocd/ directory" | ||
{ | ||
"argocd": { | ||
"fileMatch": ["argocd/.+\\.yaml$"] | ||
} | ||
} | ||
``` | ||
|
||
Or if it's only a single file then something like this: | ||
|
||
```json | ||
```json title="One Argo CD file in a directory" | ||
{ | ||
"argocd": { | ||
"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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,40 +1,39 @@ | ||
The `crossplane` manager has no `fileMatch` default patterns, so it won't match any files until you configure it with a 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. | ||
To use the `crossplane` manager you must set your own `fileMatch` pattern. | ||
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": { | ||
"fileMatch": ["\\.yaml$"] | ||
} | ||
} | ||
``` | ||
|
||
If instead you have them all inside a `packages/` directory, you would add this: | ||
|
||
```json | ||
```json title="For Crossplane files in a packages/ directory" | ||
{ | ||
"crossplane": { | ||
"fileMatch": ["packages/.+\\.yaml$"] | ||
} | ||
} | ||
``` | ||
|
||
Or if it's only a single file then something like this: | ||
|
||
```json | ||
```json title="For a single Crossplane file" | ||
{ | ||
"crossplane": { | ||
"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` |