chore: Add renovate bot config validation workflow #2404
Conversation
product-auto-label
bot
added
size: s
|
Commit (948d393) resulted in check error, as expected. Hence confirmed it is workin on this repository. |
|
Confirming behaviour for one of downstream repos: check run on java-logging-logback outputs this config, which matches with the actual config. So it should be working for others as well (hopefully). If needed, I can confirm the behaviour in the failure case as well (modify google-cloud-java renovate incorrectly, run the check again, verify, revert the changes). |
.github/workflows/ci.yaml
Outdated
| @@ -321,3 +321,20 @@ jobs: | |||
| uses: ./java-shared-dependencies/unmanaged-dependency-check | |||
| with: | |||
| bom-path: gapic-generator-java-bom/pom.xml | |||
|
|
|||
| renovate_config_check: | |||
There was a problem hiding this comment.
Can you make this as independent workflow?
Then I think of 2 options:
- workflow dispatch to periodically validate the config files in ~13 repositories. It's installed in sdk-platform-java.
- workflow for pull requests that touches renovate.json. It's installed in every ~13 repositories via synthtool template.
What is the trade off?
There was a problem hiding this comment.
synthool is better, periodically validating makes no sense if we can run it upon every touch to renovate.json
Raised googleapis/synthtool#1920
There was a problem hiding this comment.
Trade off:
- Using manual workflow dispatch for periodic validation is not a good idea because
(a) Manual invocation required everytime
(b) If there is an error in the config, we would get to know about it only when we run this check manually. - Using synthtool, this check will be installed as an independent workflow in each repository, running on every commit to config file, hence catching errors as and when they are about to be committed. This way we can catch the error faster and better. Cons about this is the maintenance toil via the synthool template.
Hence going with synthool.
.kokoro/presubmit/common.sh
Outdated
| @@ -87,3 +87,9 @@ function find_last_release_version { | |||
| parts=($(echo "$primary_artifact" | tr ":" "\n")) | |||
| echo "${parts[1]}" | |||
| } | |||
|
|
|||
| function validate_renovate_config { | |||
There was a problem hiding this comment.
I see the command is in the workflow YAML file. This seems unnecessary.
|
|
ddixit14
changed the title
Changes in this PR introduce renovate bot config validation workflow for this repository. Upon every commit to "renovate.json" file, this check will run.