Skip to content

Commit

Permalink
docs: align readme with new features
Browse files Browse the repository at this point in the history
Signed-off-by: Nico <rainbowstack@gmail.com>
  • Loading branch information
bluebrown committed May 28, 2024
1 parent 066dcfe commit 247d1bd
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,20 @@ should be matched (not including v2).
Note that the regex type will add `^` and `$` to the tag-name, to ensure the
regex matches the entire tag, so dont include them in the tag-name.

It is also possible to update only a part of a given image reference. For
example it is common for helm charts to split the reference across field, like
`repo` and `tag`.

```yaml
image:
tag: "1.0" # kobold: tag: ^1; type: semver; part: tag; context: docker.io/library/busybox
---
```

In this case, the `part` field specifies the part of the image reference to be
updated, and the `context` field specifies the image reference to be updated.
Next to `tag`, `digest` and `tag+digest`, are also supported.

## Configuration

Kobold is configured by setting up named channels, and pipelines to run
Expand Down

0 comments on commit 247d1bd

Please sign in to comment.