Use renovate for evergreen Kibana clients #1357
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR configures Renovate to automatically track and update Kibana OpenAPI specification dependencies by monitoring the Kibana repository's main branch and triggering client regeneration when changes occur.
Key changes:
- Adds custom regex manager to track Kibana git digest from Makefile
- Configures post-upgrade tasks to regenerate Kibana API clients
- Enables automerge with squash strategy for automatic dependency updates
| "customManagers": [ | ||
| { | ||
| "customType": "regex", | ||
| "managerFilePatterns": ["/^generated/kbapi/Makefile$/"], | ||
| "matchStrings": ["github_ref \\?= (?<currentDigest>.*?)\\n"], | ||
| "currentValueTemplate": "main", | ||
| "depNameTemplate": "kibana-openapi-spec", | ||
| "packageNameTemplate": "https://github.com/elastic/kibana", | ||
| "datasourceTemplate": "git-refs" | ||
| } | ||
| ], |
There was a problem hiding this comment.
The regex pattern github_ref \\?= (?<currentDigest>.*?)\\n uses a non-greedy quantifier .*? followed by \\n, but this may not correctly capture git digests which are typically 40-character SHA hashes. Consider using a more specific pattern like github_ref \\?= (?<currentDigest>[a-f0-9]{40}) to ensure only valid git commit hashes are matched.
Copilot uses AI. Check for mistakes.
tobio
force-pushed
the
renovate-kibana-client
branch
from
89d5e9f to
48123dc
Compare
There was a problem hiding this comment.
Yeah this seems like a good way to keep things up to date. Especially in the near term.
From 1309
One option here is that CI creates a provider PR based on the spec in the Kibana PR. We (i.e the author of the Kibana PR) can then update the provider codebase to handle the changing API, and then merge both provider and Kibana PR's together.
I suppose with this change we are no longer going to pursue this part of 1309?
|
Yea, I don't think we'll go down that route at the moment. We'll need to coordinate with Kibana on the best way to handle that case and this seemed like a quick win to keep us moving forward for now. It may end up that this is good enough, and product teams can be directed to rectify any failures via the Renovate PRs. |
2 participants
Related to #1309
Ideally we want to track Kibana spec changes, we already have a tool which track dependency updates, we should use that to keep the Kibana client up to date.
There's some benefits here:
There's some downsides though: