Skip to content

Commit 0110975

Browse files
authored
docs: rewrite Crossplane and Argo CD manager (#25911)
1 parent 8eefcbc commit 0110975

File tree

2 files changed

+26
-30
lines changed

2 files changed

+26
-30
lines changed

Diff for: lib/modules/manager/argocd/readme.md

+9-12
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,31 @@
1-
The `argocd` manager has no `fileMatch` default patterns, so it won't match any files until you configure it with a pattern.
2-
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.
1+
To use the `argocd` manager you must set your own `fileMatch` pattern.
2+
The `argocd` manager has no default `fileMatch` pattern, because there is no common filename or directory name convention for Argo CD YAML files.
3+
By setting your own `fileMatch` Renovate avoids having to check each `*.yaml` file in a repository for a Argo CD definition.
34

4-
If most `.yaml` files in your repository are argocd ones, then you could add this to your config:
5+
If you need to change the versioning format, read the [versioning](../../../modules/versioning.md) documentation to learn more.
56

6-
```json
7+
Some configuration examples:
8+
9+
```json title="If most .yaml files in your repository are for Argo CD"
710
{
811
"argocd": {
912
"fileMatch": ["\\.yaml$"]
1013
}
1114
}
1215
```
1316

14-
If instead you have them all inside a `argocd/` directory, you would add this:
15-
16-
```json
17+
```json title="Argo CD YAML files are in a argocd/ directory"
1718
{
1819
"argocd": {
1920
"fileMatch": ["argocd/.+\\.yaml$"]
2021
}
2122
}
2223
```
2324

24-
Or if it's only a single file then something like this:
25-
26-
```json
25+
```json title="One Argo CD file in a directory"
2726
{
2827
"argocd": {
2928
"fileMatch": ["^config/applications\\.yaml$"]
3029
}
3130
}
3231
```
33-
34-
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.

Diff for: lib/modules/manager/crossplane/readme.md

+17-18
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,39 @@
1-
The `crossplane` manager has no `fileMatch` default patterns, so it won't match any files until you configure it with a pattern.
2-
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.
1+
To use the `crossplane` manager you must set your own `fileMatch` pattern.
2+
The `crossplane` manager has no default `fileMatch` pattern, because there is no common filename or directory name convention for Crossplane YAML files.
3+
By setting your own `fileMatch` Renovate avoids having to check each `*.yaml` file in a repository for a Crossplane Package definition.
34

4-
If most `.yaml` files in your repository are Crossplane ones, then you could add this to your config:
5+
The `crossplane` manager supports these `depType`s:
56

6-
```json
7+
- `configuration`
8+
- `function`
9+
- `provider`
10+
11+
You can use these `depType`'s to control which dependencies Renovate will upgrade.
12+
13+
If you need to change the versioning format, read the [versioning](../../../modules/versioning.md) documentation to learn more.
14+
15+
Some configuration examples:
16+
17+
```json title="If most .yaml files are for Crossplane"
718
{
819
"crossplane": {
920
"fileMatch": ["\\.yaml$"]
1021
}
1122
}
1223
```
1324

14-
If instead you have them all inside a `packages/` directory, you would add this:
15-
16-
```json
25+
```json title="For Crossplane files in a packages/ directory"
1726
{
1827
"crossplane": {
1928
"fileMatch": ["packages/.+\\.yaml$"]
2029
}
2130
}
2231
```
2332

24-
Or if it's only a single file then something like this:
25-
26-
```json
33+
```json title="For a single Crossplane file"
2734
{
2835
"crossplane": {
2936
"fileMatch": ["^config/provider\\.yaml$"]
3037
}
3138
}
3239
```
33-
34-
If you need to change the versioning format, read the [versioning](https://docs.renovatebot.com/modules/versioning/) documentation to learn more.
35-
36-
The `crossplane` manager has three `depType`s to allow a fine-grained control of which dependencies are upgraded:
37-
38-
- `configuration`
39-
- `function`
40-
- `provider`

0 commit comments

Comments
 (0)