Skip to content

docs: auto-generate config filenames#41254

Open
jamietanna wants to merge 1 commit intomainfrom
docs/autogenerate-config
Open

docs: auto-generate config filenames#41254
jamietanna wants to merge 1 commit intomainfrom
docs/autogenerate-config

Conversation

@jamietanna
Copy link
Contributor

Changes

As noted in #40608, we're currently showing an outdated list of possible
configuration filenames.

We can instead automate this by using the known configuration files we
know, and all platform-specific filenames.

We should also be more explicit that the Platform-specific filenames are
only followed when running on that Platform.

Context

Please select one of the below:

AI assistance disclosure

Did you use AI tools to create any part of this pull request?

Please select one option and, if yes, briefly describe how AI was used (e.g., code, tests, docs) and which tool(s) you used.

  • No — I did not use AI for this contribution.
  • Yes — minimal assistance (e.g., IDE autocomplete, small code completions, grammar fixes).
  • Yes — substantive assistance (AI generated non‑trivial portions of code, tests, or documentation).
  • Yes — other (please describe):

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please select one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

The public repository:

@jamietanna
Copy link
Contributor Author

jamietanna commented Feb 19, 2026

You can store your Renovate configuration file in one of these locations:

1. `renovate.json`
1. `renovate.json5`
1. `.github/renovate.json`
1. `.github/renovate.json5`
1. `.gitlab/renovate.json`
1. `.gitlab/renovate.json5`
1. `.renovaterc`
1. `.renovaterc.json`
1. `.renovaterc.json5`
1. `package.json` _(within a `"renovate"` section)_

Or in a custom file present within the [`configFileNames`](./self-hosted-configuration.md#configfilenames).
The bot first checks all the files in the `configFileNames` array before checking from the above file list.

@jamietanna jamietanna marked this pull request as ready for review February 19, 2026 08:01
@jamietanna jamietanna enabled auto-merge February 19, 2026 08:03
@jamietanna jamietanna force-pushed the docs/autogenerate-config branch from ec07ace to 93ff2e2 Compare February 19, 2026 08:04
@viceice
Copy link
Member

viceice commented Feb 19, 2026

are we sure tjie platform config files are already fully implemented? I remember the we maybe didn't pass the platform parameters yet 🤔

@jamietanna
Copy link
Contributor Author

@RahulGautamSingh would you be able to double check, please? 🙏

@jamietanna
Copy link
Contributor Author

Related: #10682 #10651

@RahulGautamSingh RahulGautamSingh self-requested a review February 24, 2026 07:59
Copy link
Collaborator

@RahulGautamSingh RahulGautamSingh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Comment on lines +256 to +258
for (const [id] of platforms) {
filenames.push(...getConfigFileNames(id));
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we should exclude it for now, as we don't use the argument yet

@jamietanna jamietanna force-pushed the docs/autogenerate-config branch from 93ff2e2 to 1f16a79 Compare February 25, 2026 14:43
@jamietanna
Copy link
Contributor Author

OK, so this change was off the back of #40608 but maybe I've misunderstood as I thought that #40065 was actually being used, but it looks like it's not until #10682 #10651 ?

Right now, we can merge this in, and the output will be effectively what we've got (but less likely to go out of date)

However, until #10682 #10651 the changes in this PR will slightly be useful, but not super helpful

As noted in #40608, we're currently showing an outdated list of possible
configuration filenames.

We can instead automate this by using the known configuration files we
know.

As we don't yet support the Platform-specific filenames, we shouldn't
include them, but add a TODO so we don't miss it.
@jamietanna jamietanna force-pushed the docs/autogenerate-config branch from 1f16a79 to ef1583f Compare February 25, 2026 14:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Configuration filename options are outdated

3 participants