Error after switching presets to use json5 filename

[wyardley]

How are you running Renovate?

A Mend.io-hosted app

If you're self-hosting Renovate, tell us which platform (GitHub, GitLab, etc) and which version of Renovate.

GitHub

Please tell us more about your question or problem

I have a config in my org in the typical / magic "renovate-config" repo name. This has been working as expected with individual repos extending

  "extends": [
    "local>myorg/renovate-config"
  ],

I recently tried updating the configs in the renovate-config repo to have the json5 extension, since I noticed Renovate supports it now (and will parse JSON in a flexible way either way, but with a warning when not using the .json5 extension).

The config in an example repo consuming this config validates successfully with renovate-config-validator as well:

 INFO: Config validated successfully

However, the project then gets an error:

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Error type: Cannot find preset's package (local>myorg/renovate-config)

Using the json5 extension validates ok in the config repo, and I see this post about using the .json5 extension for presets, but looking at these docs, I only see mention of default.json being followed. Do I need to render json5 down to pure json for the preset configs? Is there an easy way to keep comments in my config repo's JSON config, but also avoid an error with the presets?

Logs (if relevant)

Logs

DEBUG: Preset fetch error
{
  "preset": "local>myorg/renovate-config"
  "err": {
    "message": "dep not found",
    "stack": "Error: dep not found\n    at fetchJSONFile (/usr/local/renovate/lib/config/presets/github/index.ts:33:11)\n    at processTicksAndRejections (node:internal/process/task_queues:105:5)\n    at fetchPreset (/usr/local/renovate/lib/config/presets/util.ts:42:21)\n    at getPreset (/usr/local/renovate/lib/config/presets/index.ts:132:20)\n    at fetchPreset (/usr/local/renovate/lib/config/presets/index.ts:269:12)\n    at Object.resolveConfigPresets (/usr/local/renovate/lib/config/presets/index.ts:202:31)\n    at mergeRenovateConfig (/usr/local/renovate/lib/workers/repository/init/merge.ts:234:5)\n    at getRepoConfig (/usr/local/renovate/lib/workers/repository/init/config.ts:14:12)\n    at initRepo (/usr/local/renovate/lib/workers/repository/init/index.ts:58:12)\n    at Object.renovateRepository (/usr/local/renovate/lib/workers/repository/index.ts:64:14)\n    at attributes.repository (/usr/local/renovate/lib/workers/global/index.ts:206:11)\n    at start (/usr/local/renovate/lib/workers/global/index.ts:191:7)\n    at /usr/local/renovate/lib/renovate.ts:19:22"
  }
}

INFO: Throwing preset error
{
  "validationError": "Cannot find preset's package (local>myorg/renovate-config)"
}

INFO: Repository has invalid config
{
  "error": {
    "validationError": "Cannot find preset's package (local>myorg/renovate-config)",
    "message": "config-validation",
    "stack": "Error: config-validation\n    at fetchPreset (/usr/local/renovate/lib/config/presets/index.ts:278:19)\n    at processTicksAndRejections (node:internal/process/task_queues:105:5)\n    at Object.resolveConfigPresets (/usr/local/renovate/lib/config/presets/index.ts:202:31)\n    at mergeRenovateConfig (/usr/local/renovate/lib/workers/repository/init/merge.ts:234:5)\n    at getRepoConfig (/usr/local/renovate/lib/workers/repository/init/config.ts:14:12)\n    at initRepo (/usr/local/renovate/lib/workers/repository/init/index.ts:58:12)\n    at Object.renovateRepository (/usr/local/renovate/lib/workers/repository/index.ts:64:14)\n    at attributes.repository (/usr/local/renovate/lib/workers/global/index.ts:206:11)\n    at start (/usr/local/renovate/lib/workers/global/index.ts:191:7)\n    at /usr/local/renovate/lib/renovate.ts:19:22"
  }
}

[secustor]

You have to define the file name if not using json https://docs.renovatebot.com/config-presets/

You can also extend in default.json to default.json5 to not break existing integrations.

[wyardley]

Thank you. I missed this.
Maybe it’s not possible due to being breaking, but if you all would consider a feature request at some point to support preset.json5 as equivalent to preset.json if not present, IMO, this would be the best and least surprising behavior, but I understand the reasons this might not be feasible.

[rarkins]

We prefer not to because it would mean wasted API calls to try/fail/retry

[wyardley]

Ok, thanks, makes sense.
Based on the docs you linked, looks like if there's a default.json5, it won't push that as the preset when bootstrapping repos, right? So I'd have to either do the passthrough thing, or stub in a default.json with an explicit onboardingConfig to push out the default.json5 to newly onboarded repos?

Probably will just switch back to regular JSON for now.