Split and fix renovate config #767

nadiamoe · 2024-07-04T10:12:48Z

When selfhosted, renovate requires a separate config file (ref). This PR splits out self-hosted options to a different file, and points renovate itself to it. Additionally:

Migrates repo config to json5 (as it allows comments)
Simplifies the regex looking for grafana-build-tools container image
Removes gitAuthor, so renovate can rebase PRs created by itself with platformCommit (Renovate marks nearly all PRs as "edited" with `platformCommit: true` renovatebot/renovate#29106)

Ref: renovatebot/renovate#29106

mem · 2024-07-04T18:04:10Z

When selfhosted, renovate requires a separate config file (ref). This PR splits out self-hosted options to a different file, and points renovate itself to it. Additionally:

Migrates repo config to json5 (as it allows comments)

I avoided using json5 because pretty much nothing supports it. There are good reasons for that. If you want comments in json, can I suggest that you use jsonnet? Every json document is a valid jsonnet input.

And it was disappointing to find that renovate explicitly declined supporting YAML as the configuration format. Not that I like YAML, but I admit that it's better than JSON at this kind of thing.

Removes gitAuthor, so renovate can rebase PRs created by itself with platformCommit (Renovate marks nearly all PRs as "edited" with platformCommit: true renovatebot/renovate#29106)

I copied the configuration from the docs, thinking that was going to provide a simpler path forward. I was so mistaken...

I noticed in the renovate docs that there's some kind of staging / testing functionality. Do you have any experience with that? I would love to avoid the PR / merge / diagnose / PR / ... cycle if possible.

mem

It's OK, I guess.

I would like to understand why for the changes. I can figure out the what myself just by reading thru the changes.

mem · 2024-07-04T18:16:19Z

.github/renovate.json5

@@ -48,7 +50,7 @@
        ".*\\.mk$"
      ],
      "matchStrings": [
-        "\\bghcr\\.io/(?<depName>grafana/grafana-build-tools):(?<currentValue>\\S+)\\b"
+        "ghcr.io/grafana/grafana-build-tools:(?<currentValue>\\S+)"


I do not like to play loose with regular expressions.

What's the problem with correctly anchoring the regular expression? And what's the problem with correctly escaping things that need escaping?

I almost threw up when I realized that renovate does global matches, because that does make writing regular expressions much more complicated, e.g. you cannot reasonably anchor at the beginning or end of a line.

Incidentally, the reason why they do global matches is because they encourage you do to what you are removing here: use named captures to provide configuration values, so I don't quite understand why you are removing that instead of just changing the named capture so that it starts before ghcr.

What's the problem with correctly anchoring the regular expression?

This is not a strong opinion.

I've been using renovate and its terrible (and yet awesome) regexes for several years, and I've gone through efforts of making regexes very specific and robust so they don't catch things they shouldn't by mistake. Then I stopped doing it. Since I do the simplest, dumbest, possible regex I've noticed two things:

Dumb regexes have never caught up things they shouldn't. Not a single time.

I can actually read the dumb regex three days after I write it.

For those two reasons I keep the shortest, simplest possible one that I cannot anticipate breaking.

use named captures to provide configuration values

Also not a strong opinion. I've found prematurely generalizing managers also obscures the reasoning for the rule being added, and also adds cognitive complexity (just like the regex).

mem · 2024-07-04T18:19:58Z

.github/renovate-selfhosted.json

Can you point me to the documentation that explains what's going on here? I can see that you are pointing the action at this file. How is the other one used then?

My guess: you are saying that this file is the configuration file for the GitHub App, and the other file is the configuration file for renovate (i.e. renovate doesn't care about this one). Is that it?

I added a link in the PR, but probably not in the most readable way. Sorry about that.

Yep, this is the "self hosted configuration", as renovate refers to it. It is documented here: https://docs.renovatebot.com/self-hosted-configuration/

Note the following paragraph:

Do not put the self-hosted config options listed on this page in your "repository config" file (renovate.json for example), because Renovate will ignore those config options, and may also create a config error issue.

The repository configuration is described, in turn, here: https://docs.renovatebot.com/configuration-options/. That one is not referenced anywhere because it is one of the (many, arguably too many) default paths renovate looks for after cloning the repo.

This is a bit more obvious when renovate does not live in the same repo it manages (e.g. when you run the bot itself on k8s), as the self-hosted configuration lives next to the bot, and not in the repository.

Argh...

Thanks for the explanation.

The other day when I was working on this I started to hate renovate because the documentation is really bad (having a lot of documentation is not the same thing as having good documentation). Now I hate it even more. I did see that line you refer to, I did not (obviously) pick up on the subtlety it's trying to express.

I guess I have to write a PR for the repo where I got the example from...

mem · 2024-07-04T18:21:00Z

.github/renovate.json5

      "customType": "regex",
-      "datasourceTemplate": "github-tags",
+      "depNameTemplate": "ghcr.io/grafana/grafana-build-tools",
+      "datasourceTemplate": "docker",


It's OK for me either way, but why is this better?

I don't think it is better, it should work the same. It is perhaps a bit more obvious. When I first saw this I wondered: Is there a reason to not do the obvious thing and look at the OCI registry for OCI image tags?

The reason is that I was trying to test the configuration before actually committing anything to the repo, and with docker it was failing in even less useful ways than with github-tags.

I do think docker is the right thing to do here, because in this case the tag might be published a long time before the docker image is available.

That's interesting, I'll follow up on that to see why that might happen.

nadiamoe · 2024-07-04T19:53:04Z

I wish I had. My experience is usually iterating force-pushes to main, as sad as that is. The fact that we're trying to troubleshoot renovate running as an app is pretty unconvenient, because we cannot simply run renovate locally (which is my plan B when forcepushes are not acceptable).

I tried doing that. I failed miserably. I still don't understand why. I would have been happy with a "--dry-run" or "--dont-create-commits" option.

Thanks!

EDIT: Sorry, I clicked the wrong button. I wanted to quote-reply and I clicked "edit". I have no idea how to revert that. 🤷🏽

* Chore(deps): Bump google.golang.org/grpc from 1.63.2 to 1.64.0 * grpc: nolint deprecated grpc options * Build(deps): Bump the prometheus-go group across 1 directory with 2 updates * http: rename `promconfig.Header` to `promconfig.ProxyHeader` * Add the basic stuff to support a browser check type (#737) * k6runner/test: ensure logs are sent to loki when runner reports user errors * k6runner: send logs even if metrics are malformed * Build(deps): Bump github.com/prometheus/common * Bump k6 version using renovate (#745) * Dispatch renovate workflow manually (#746) * Update renovate (#748) * Update dependency grafana/k6 to v0.52.0 (#749) * Fix renovate configuration (#751) * Update github.com/grafana/loki/pkg/push digest to 04bc3a4 (#752) * Update module github.com/dmarkham/enumer to v1.5.10 (#754) * Update module github.com/sirupsen/logrus to v1.9.3 (#755) * Update module github.com/stretchr/testify to v1.9.0 (#759) * Update dependency grafana/grafana-build-tools to v0.15.0 (#756) * Correct the listen address to scrape metrics to port 4050. (#743) * Build(deps): Bump google.golang.org/grpc from 1.64.0 to 1.65.0 * Update module github.com/securego/gosec to v2 * Split and fix renovate config (#767) * Update ghcr.io/grafana/grafana-build-tools Docker tag to v0.15.1 (#770) * add validation case for browser (#773) * Update module gotest.tools/gotestsum to v1.12.0 * Update module go.k6.io/k6 to v0.52.0 * Update golang.org/x/exp digest to 7f521ea * Update module golang.org/x/net to v0.27.0 (#775) * Update module github.com/securego/gosec to v2 * Update module gotest.tools/gotestsum to v1.12.0 * Update module github.com/spf13/afero to v1.11.0 (#758) * Update module github.com/golangci/golangci-lint to v1.59.1 * Update github.com/grafana/loki/pkg/push digest to 6da364e * Update module github.com/securego/gosec to v2 * Route browser checks to the browser prober (#780) * Update module google.golang.org/grpc to v1.65.0 (#761) * ci/renovate: limit gomod digest updates to once every two weeks (#785) * Update golang.org/x/exp digest to 46b0784 (#781) * cmd: default to sm-k6 binary * Dockerfile: copy sm-specific k6 as sm-k6 instead of just k6 * k6runner/test: pass address of expectErrorAs to errors.As * k6runner: log errors encountered by logfmt parser * Update github.com/grafana/loki/pkg/push digest to 7c86e65 * Add browser limits and class (#787) * Update module github.com/prometheus/prometheus to v0.53.1 (#790) * Report browser check's class as browser (#788) * Update github.com/grafana/loki/pkg/push digest to 527510d (#793) * Update github.com/securego/gosec/v2 digest to 4487a0c Signed-off-by: Ro Santalla <[email protected]>

nadiamoe requested a review from a team as a code owner July 4, 2024 10:12

nadiamoe added 2 commits July 4, 2024 12:39

ci/renovate: split configuration

ae97c2f

ci/renovate: use docker datasource for grafana-build-tools

4f3e319

nadiamoe force-pushed the split-renovate branch from 0ea0f8a to 4f3e319 Compare July 4, 2024 10:39

ci/renovate: do not set gitAuthor

5b9bfb4

Ref: renovatebot/renovate#29106

nadiamoe force-pushed the split-renovate branch from 3989588 to 5b9bfb4 Compare July 4, 2024 11:28

nadiamoe changed the title ~~Split renovate config~~ Split and fix renovate config Jul 4, 2024

mem reviewed Jul 4, 2024

View reviewed changes

mem approved these changes Jul 4, 2024

View reviewed changes

mem merged commit aaa8c72 into main Jul 4, 2024
2 checks passed

mem deleted the split-renovate branch July 4, 2024 20:20

mem mentioned this pull request Jul 4, 2024

Fix .github/renovate.json #750

Closed

nadiamoe mentioned this pull request Jul 15, 2024

Release v0.25.0 #796

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Split and fix renovate config #767

Split and fix renovate config #767

nadiamoe commented Jul 4, 2024 •

edited

Loading

mem commented Jul 4, 2024 •

edited

Loading

mem left a comment

mem Jul 4, 2024

mem Jul 4, 2024

nadiamoe Jul 4, 2024

mem Jul 4, 2024

nadiamoe Jul 4, 2024

nadiamoe Jul 4, 2024

mem Jul 4, 2024

mem Jul 4, 2024

nadiamoe Jul 4, 2024

mem Jul 4, 2024

nadiamoe Jul 5, 2024

nadiamoe commented Jul 4, 2024 •

edited by mem

Loading

Split and fix renovate config #767

Split and fix renovate config #767

Conversation

nadiamoe commented Jul 4, 2024 • edited Loading

mem commented Jul 4, 2024 • edited Loading

mem left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nadiamoe commented Jul 4, 2024 • edited by mem Loading

nadiamoe commented Jul 4, 2024 •

edited

Loading

mem commented Jul 4, 2024 •

edited

Loading

nadiamoe commented Jul 4, 2024 •

edited by mem

Loading