diff --git a/lib/modules/manager/argocd/readme.md b/lib/modules/manager/argocd/readme.md index d954606bc7e6de7772b18f0a070b0c4e66149fe0..f00c6f5bfd24474a5ef092c734f75efdc90012d6 100644 --- a/lib/modules/manager/argocd/readme.md +++ b/lib/modules/manager/argocd/readme.md @@ -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. -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$"] @@ -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 +```json title="Argo CD YAML files are in a argocd/ directory" { "argocd": { "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 +```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. diff --git a/lib/modules/manager/crossplane/readme.md b/lib/modules/manager/crossplane/readme.md index 0cfc4fd95ee81478ae9bb3cc44805fe2b764dcb2..68b661596ef16bc2de00a8bf605f74abecf301a7 100644 --- a/lib/modules/manager/crossplane/readme.md +++ b/lib/modules/manager/crossplane/readme.md @@ -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. -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$"] @@ -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 +```json title="For Crossplane files in a packages/ directory" { "crossplane": { "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 +```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`