Allow renovate MRs CI configuration via comments
What does this MR do and why?
One major pain point since our CI rework is that renovate MR cannot used properly the MR description to configure the CI. Each time the renovate bot runs it override the MR description.
This MR propose an alternative to manage this issue.
- Update
.gitlab/ci/scripts/generate_deployment_jobs.pyscript, to be able to use a CI configuration from a comment in MR - Clean the CI check around
renovate.json - Remove the script to generate
renovate.jsonprFootter - Update
renovate.jsonprfooter
The workflow will be:
IF CI variable `DEPLOYMENT_DESCRIPTION_OVERRIDE` is set it override I configuration in any case
IF CI variable `DEPLOYMENT_DESCRIPTION` is set, refer to config in `predefined-pipelines-config.yaml`
ELSE we try to use CI config from MR description
IF no valid CI configuration is found (no tick box check or no configuration at all)
IF `renovate` label is present
CHECK if a comment from the bot is present
IF yes, try to parse it to retrieve the CI configuration
IF not, post a comment with a default configuration from `.gitlab/ci/configuration/default-renovate-comment.md` file
IF no CI configuration found use either CAPO or Default CI configuration from `.gitlab/ci/configuration/predefined-pipelines-config.yaml` file
as fallback, get default config
Related reference(s)
Test coverage
CI configuration
Below you can choose test deployment variants to run in this MR's CI.
Click to open to CI configuration
Legend:
| Icon | Meaning | Available values |
|---|---|---|
| Infra Provider |
capd, capo, capm3
|
|
| Bootstrap Provider |
kubeadm (alias kadm), rke2
|
|
| Node OS |
ubuntu, suse
|
|
| Deployment Options |
light-deploy, dev-sources, ha, misc
|
|
| Pipeline Scenarios | Available scenario list and description |
-
🎬 preview☁️ capd🚀 kadm🐧 ubuntu -
🎬 preview☁️ capo🚀 rke2🐧 suse -
🎬 preview☁️ capm3🚀 rke2🐧 ubuntu -
☁️ capd🚀 kadm🛠️ light-deploy🐧 ubuntu -
☁️ capd🚀 rke2🛠️ light-deploy🐧 suse -
☁️ capo🚀 rke2🐧 suse -
☁️ capo🚀 kadm🐧 ubuntu -
☁️ capo🚀 rke2🎬 rolling-update🛠️ ha🐧 ubuntu -
☁️ capo🚀 kadm🎬 wkld-k8s-upgrade🐧 ubuntu -
☁️ capo🚀 rke2🎬 rolling-update-no-wkld🛠️ ha,misc🐧 suse -
☁️ capo🚀 rke2🎬 sylva-upgrade-from-1.3.x🛠️ ha,misc🐧 ubuntu -
☁️ capm3🚀 rke2🐧 suse -
☁️ capm3🚀 kadm🐧 ubuntu -
☁️ capm3🚀 kadm🎬 rolling-update-no-wkld🛠️ ha,misc🐧 ubuntu -
☁️ capm3🚀 rke2🎬 wkld-k8s-upgrade🛠️ ha🐧 suse -
☁️ capm3🚀 kadm🎬 rolling-update🛠️ ha🐧 ubuntu -
☁️ capm3🚀 rke2🎬 sylva-upgrade-from-1.3.x🛠️ misc,ha🐧 suse -
☁️ capm3🚀 kadm🎬 rolling-update🛠️ ha🐧 suse
Global config for deployment pipelines
-
autorun pipelines -
allow failure on pipelines
Notes:
- Enabling
autorunwill make deployment pipelines to be run automatically without human interaction - Disabling
allow failurewill make deployment pipelines mandatory for pipeline success. - if both
autorunandallow failureare disabled, deployment pipelines will need manual triggering but will be blocking the pipeline
Be aware: after configuration change, pipeline is not triggered automatically.
Please run it manually (by clicking the run pipeline button in Pipelines tab) or push new code.