renovate/lib/manager/batect/readme.md
Charles Korn 61da4d60b0
feat(batect): Automatically extract dependencies for files included into Batect configuration (#8091)
* Automatically extract dependencies for files included into Batect configuration.

* Fix issue running tests on Windows.

* Simplify language in readme.

* Use sets rather than arrays to manage backlog of files to examine.

* Remove explicitly setting manager name.

* Address PR feedback.

Co-authored-by: Jamie Magee <JamieMagee@users.noreply.github.com>
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
2020-12-21 12:18:53 +01:00

33 lines
1.1 KiB
Markdown

Extracts all Docker images and Batect bundles from Batect configuration files.
For updates to Batect itself, see [batect-wrapper](../batect-wrapper).
### Files searched
By default, the manager searches for files called `batect.yml` or `batect-bundle.yml`.
If you keep your Batect configuration in other files, you'll need to tell Renovate where to find them.
Files included in your main configuration file with `include` don't need to be listed.
You do this by creating a `"batect"` object in your `renovate.json` file.
This object should contain a `fileMatch` array with regular expressions that match the configuration file names.
For example:
```json
{
"batect": {
"fileMatch": [
"(^|/)batect(-bundle)?\\.yml$",
"(^|/)my-other-batect-file\\.yml$",
"^a-directory/[^/]*\\.yml$"
]
}
}
```
### Bundle versioning
This manager assumes that any bundles referenced use tags for versioning, and that these tags use [SemVer](../../versioning/semver).
The implementation of SemVer is strict - versions must follow the `X.Y.Z` or `vX.Y.Z` format.
Versions that don't match this format (eg. `X.Y`) will be ignored.