Skip to content

feat(docs): add section about bumping Cluster imageName using renovate #330

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

feat(docs): add section about bumping Cluster imageName using renovate #330

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed5090c
feat(docs): add section about bumping `Cluster` `imageName` using ren…
DerRockWolf Sep 27, 2025
356443c
update matchStrings regex to treat digest as optional
DerRockWolf Oct 5, 2025
b2a2d22
clarify `compatibility` part
DerRockWolf Oct 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,34 @@ cosign verify IMAGE \
For detailed instructions on building PostgreSQL container images, refer to the
[BUILD.md](BUILD.md) file.

## Automatic Updating using Renovate

[Renovate](https://github.com/renovatebot/renovate) can be used to automatically update various dependencies.
As CloudNativePG's `Cluster` CRDs are not automatically picked up by renovate a custom regex manager must be configured:

```json5
{
customManagers: [
{
// cloudnative-pg instance version
customType: 'regex',
managerFilePatterns: [
'/\\.yaml$/',
],
matchStrings: [
'imageName: (?<depName>[^\\s:]+):(?<currentValue>[^\\s@]+)(?:@(?<currentDigest>sha256:[a-f0-9]+))?',
],
datasourceTemplate: 'docker',
// matches: 17.6-202509151215-minimal-trixie
versioningTemplate: 'regex:^(?<major>\\d+)\\.(?<minor>\\d+)-(?<patch>\\d+)-(?<compatibility>\\S+)$',
autoReplaceStringTemplate: '{{{newValue}}}{{#if newDigest}}@{{{newDigest}}}{{/if}}',
}
]
}
```

Renovate will never change the `compatibility` part of the tag, ensuring that the upgraded images will remain compatible.

## License and copyright

This software is available under [Apache License 2.0](LICENSE).
Expand Down