Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions lib/config/global.ts
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ export class GlobalConfig {
'prCacheSyncMaxPages',
'presetCachePersistence',
'repositoryCacheForceLocal',
'requireConfig',
's3Endpoint',
's3PathStyle',
'toolSettings',
Expand Down
1 change: 1 addition & 0 deletions lib/config/inherit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export class InheritConfig {
'onboardingConfigFileName',
'onboardingNoDeps',
'onboardingPrTitle',
'requireConfig',
];

private static config: GlobalInheritableConfig = {};
Expand Down
1 change: 1 addition & 0 deletions lib/config/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@ export interface GlobalInheritableConfig {
onboardingConfigFileName?: string;
onboardingNoDeps?: 'auto' | 'enabled' | 'disabled';
onboardingPrTitle?: string;
requireConfig?: RequiredConfig;
}

// Config options used only within the global worker
Expand Down
3 changes: 3 additions & 0 deletions lib/workers/repository/init/merge.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import type { RenovateConfig } from '~test/util.ts';
import { fs, logger, partial, platform, scm } from '~test/util.ts';
import * as decrypt from '../../../config/decrypt.ts';
import { getConfig } from '../../../config/defaults.ts';
import { GlobalConfig } from '../../../config/global.ts';
import * as _migrateAndValidate from '../../../config/migrate-validate.ts';
import * as _migrate from '../../../config/migration.ts';
import type { AllConfig } from '../../../config/types.ts';
Expand Down Expand Up @@ -44,6 +45,7 @@ function mockProcessExitOnce(): [MockInstance<NodeJS.Process['exit']>, Error] {

beforeEach(() => {
memCache.init();
GlobalConfig.reset();
config = getConfig();
config.errors = [];
config.warnings = [];
Expand Down Expand Up @@ -387,6 +389,7 @@ describe('workers/repository/init/merge', () => {
warnings: [],
errors: [],
});
GlobalConfig.set({ requireConfig: 'ignored' });
expect(
await mergeRenovateConfig({
...config,
Expand Down
4 changes: 2 additions & 2 deletions lib/workers/repository/init/merge.ts
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ import { platform } from '../../../modules/platform/index.ts';
import { scm } from '../../../modules/platform/scm.ts';
import { ExternalHostError } from '../../../types/errors/external-host-error.ts';
import { getCache } from '../../../util/cache/repository/index.ts';
import { parseJson } from '../../../util/common.ts';
import { getInheritedOrGlobal, parseJson } from '../../../util/common.ts';
import { setUserEnv } from '../../../util/env.ts';
import { readLocalFile, readSystemFile } from '../../../util/fs/index.ts';
import * as hostRules from '../../../util/host-rules.ts';
Expand Down Expand Up @@ -189,7 +189,7 @@ export async function mergeRenovateConfig(
): Promise<RenovateConfig> {
let returnConfig = { ...config };
let repoConfig: RepoFileConfig = {};
if (config.requireConfig !== 'ignored') {
if (getInheritedOrGlobal('requireConfig') !== 'ignored') {
repoConfig = await detectRepoFileConfig(branchName);
}
if (!repoConfig.configFileParsed && config.mode === 'silent') {
Expand Down
2 changes: 1 addition & 1 deletion lib/workers/repository/onboarding/branch/check.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ const cache = vi.mocked(_cache);

describe('workers/repository/onboarding/branch/check', () => {
beforeEach(() => {
GlobalConfig.set({ onboarding: true });
GlobalConfig.set({ onboarding: true, requireConfig: 'required' });
});

const config = partial<RenovateConfig>({
Expand Down
8 changes: 4 additions & 4 deletions lib/workers/repository/onboarding/branch/check.ts
Original file line number Diff line number Diff line change
Expand Up @@ -80,13 +80,13 @@ export async function isOnboarded(config: RenovateConfig): Promise<boolean> {
// - The current default branch SHA matches the default SHA found in the cache
// Also if there is a closed pr skip using cache as it is outdated
if (
config.requireConfig === 'optional' &&
getInheritedOrGlobal('requireConfig') === 'optional' &&
getInheritedOrGlobal('onboarding') === false
) {
// Return early and avoid checking for config files
return true;
}
if (config.requireConfig === 'ignored') {
if (getInheritedOrGlobal('requireConfig') === 'ignored') {
logger.debug('Config file will be ignored');
return true;
}
Expand Down Expand Up @@ -148,7 +148,7 @@ export async function isOnboarded(config: RenovateConfig): Promise<boolean> {
// If onboarding has been disabled and config files are required then the
// repository has not been onboarded yet
if (
config.requireConfig === 'required' &&
getInheritedOrGlobal('requireConfig') === 'required' &&
getInheritedOrGlobal('onboarding') === false
) {
throw new Error(REPOSITORY_NO_CONFIG);
Expand All @@ -159,7 +159,7 @@ export async function isOnboarded(config: RenovateConfig): Promise<boolean> {
return false;
}
logger.debug('Found closed onboarding PR');
if (config.requireConfig === 'optional') {
if (getInheritedOrGlobal('requireConfig') === 'optional') {
logger.debug('Config not mandatory so repo is considered onboarded');
return true;
}
Expand Down
8 changes: 8 additions & 0 deletions lib/workers/repository/onboarding/branch/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ describe('workers/repository/onboarding/branch/index', () => {
GlobalConfig.set({
onboarding: true,
onboardingBranch: config.onboardingBranch,
requireConfig: config.requireConfig,
});
OnboardingState.prUpdateRequested = false;
scm.getFileList.mockResolvedValue([]);
Expand Down Expand Up @@ -171,6 +172,7 @@ describe('workers/repository/onboarding/branch/index', () => {
GlobalConfig.set({
onboarding: false,
onboardingBranch: config.onboardingBranch,
requireConfig: 'optional',
});
const res = await checkOnboardingBranch(config);
expect(res.repoIsOnboarded).toBeTrue();
Expand All @@ -192,6 +194,7 @@ describe('workers/repository/onboarding/branch/index', () => {
GlobalConfig.set({
onboarding: false,
onboardingBranch: config.onboardingBranch,
requireConfig: 'ignored',
});
const res = await checkOnboardingBranch(config);
expect(res.repoIsOnboarded).toBeTrue();
Expand All @@ -202,6 +205,7 @@ describe('workers/repository/onboarding/branch/index', () => {
GlobalConfig.set({
onboarding: false,
onboardingBranch: config.onboardingBranch,
requireConfig: 'required',
});
scm.getFileList.mockResolvedValueOnce(['package.json']);
fs.readLocalFile.mockResolvedValueOnce('{}');
Expand Down Expand Up @@ -281,6 +285,10 @@ describe('workers/repository/onboarding/branch/index', () => {

it('detects repo is onboarded via PR', async () => {
config.requireConfig = 'optional';
GlobalConfig.set({
onboardingBranch: config.onboardingBranch,
requireConfig: 'optional',
});
platform.findPr.mockResolvedValueOnce(mock<Pr>());
const res = await checkOnboardingBranch(config);
expect(res.repoIsOnboarded).toBeTrue();
Expand Down
6 changes: 6 additions & 0 deletions lib/workers/repository/onboarding/pr/index.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ describe('workers/repository/onboarding/pr/index', () => {
GlobalConfig.set({
onboardingBranch: config.onboardingBranch,
onboardingPrTitle: 'Configure Renovate', // default value
requireConfig: config.requireConfig,
});
InheritConfig.reset();
});
Expand Down Expand Up @@ -465,6 +466,11 @@ describe('workers/repository/onboarding/pr/index', () => {

it('creates PR (no require config)', async () => {
config.requireConfig = 'optional';
GlobalConfig.set({
onboardingBranch: config.onboardingBranch,
onboardingPrTitle: 'Configure Renovate',
requireConfig: 'optional',
});
await ensureOnboardingPr(config, packageFiles, branches);
expect(platform.createPr).toHaveBeenCalledTimes(1);
});
Expand Down
2 changes: 1 addition & 1 deletion lib/workers/repository/onboarding/pr/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ export async function ensureOnboardingPr(
config.productLinks!.homepage
})! This is an onboarding PR to help you understand and configure settings before regular Pull Requests begin.\n\n`;
prTemplate +=
config.requireConfig === 'required'
getInheritedOrGlobal('requireConfig') === 'required'
? emojify(
`:vertical_traffic_light: To activate Renovate, merge this Pull Request. To disable Renovate, simply close this Pull Request unmerged.\n\n`,
)
Expand Down
Loading