Skip to content

Commit

Permalink
fix(config)!: globalExtends merge order (#28145)
Browse files Browse the repository at this point in the history
Previously, config from globalExtends was incorrectly merged _after_ other global config. This meant for example that packageRules in a config.js could not override packageRules from within globalExtends, because they were applied after. Now, globalExtends content will be merged first, and remaining global config merged second.

Fixes #28131

BREAKING CHANGE: order of globalExtends resolution is changed so that it is applied first and remaining global config takes precedence.
  • Loading branch information
rarkins committed Jul 23, 2024
1 parent db18662 commit 3e8a4c8
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 31 deletions.
4 changes: 0 additions & 4 deletions docs/usage/self-hosted-experimental.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,10 +60,6 @@ If set to any value, Renovate will use the Docker Hub API (`https://hub.docker.c
If set to an integer, Renovate will use this as max page number for docker tags lookup on docker registries, instead of the default 20 pages.
This is useful for registries which ignores the `n` parameter in the query string and only return 50 tags per page.

## `RENOVATE_X_EAGER_GLOBAL_EXTENDS`

Resolve and merge `globalExtends` presets before other global config, instead of after.

## `RENOVATE_X_EXEC_GPID_HANDLE`

If set, Renovate will terminate the whole process group of a terminated child process spawned by Renovate.
Expand Down
16 changes: 0 additions & 16 deletions lib/workers/global/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@ describe('workers/global/index', () => {
initPlatform.mockImplementation((input) => Promise.resolve(input));
delete process.env.AWS_SECRET_ACCESS_KEY;
delete process.env.AWS_SESSION_TOKEN;
delete process.env.RENOVATE_X_EAGER_GLOBAL_EXTENDS;
});

describe('getRepositoryConfig', () => {
Expand Down Expand Up @@ -88,21 +87,6 @@ describe('workers/global/index', () => {
expect(addSecretForSanitizing).toHaveBeenCalledTimes(2);
});

it('resolves global presets first', async () => {
process.env.RENOVATE_X_EAGER_GLOBAL_EXTENDS = 'true';
parseConfigs.mockResolvedValueOnce({
repositories: [],
globalExtends: [':pinVersions'],
hostRules: [{ matchHost: 'github.com', token: 'abc123' }],
});
presets.resolveConfigPresets.mockResolvedValueOnce({});
await expect(globalWorker.start()).resolves.toBe(0);
expect(presets.resolveConfigPresets).toHaveBeenCalledWith({
extends: [':pinVersions'],
});
expect(parseConfigs).toHaveBeenCalledTimes(1);
});

it('resolves global presets immediately', async () => {
parseConfigs.mockResolvedValueOnce({
repositories: [],
Expand Down
15 changes: 4 additions & 11 deletions lib/workers/global/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -144,17 +144,10 @@ export async function start(): Promise<number> {
config = await getGlobalConfig();
if (config?.globalExtends) {
// resolve global presets immediately
if (process.env.RENOVATE_X_EAGER_GLOBAL_EXTENDS) {
config = mergeChildConfig(
await resolveGlobalExtends(config.globalExtends),
config,
);
} else {
config = mergeChildConfig(
config,
await resolveGlobalExtends(config.globalExtends),
);
}
config = mergeChildConfig(
await resolveGlobalExtends(config.globalExtends),
config,
);
}

// Set allowedHeaders in case hostRules headers are configured in file config
Expand Down

0 comments on commit 3e8a4c8

Please sign in to comment.