Skip to content

fix: validate license policy before sync #368

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
0xPlayerOne merged 1 commit into from
Aug 4, 2026
Merged

fix: validate license policy before sync #368

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 9 additions & 6 deletions src/commands/sync.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,15 @@ export function syncRepository(options) {
if (!Object.keys(existingConfig).length && !options.init) throw new Error('Missing .github/code-foundry.yml; run init first.')
const defaults = createDefaultConfig(target, source)
let config = { ...defaults, ...existingConfig }
// Resolve and validate the license policy before any sync writes occur
// (including config/default additions) so an unsupported policy fails
// fast without leaving partially generated files behind.
const license = configured(config.license, existsSync(join(target, 'LICENSE')) ? 'preserve' : 'gpl-3.0-or-later')
const licenseFile = licenseFiles[license]
if (license !== 'preserve' && license !== 'none' && !licenseFile) {
const supported = [...Object.keys(licenseFiles), 'preserve', 'none'].join(', ')
throw new Error(`Unsupported license: ${license}; use ${supported}.`)
}
if (!Object.keys(existingConfig).length) {
writeOrReport(configPath, renderConfig(config), dryRun)
} else {
Expand Down Expand Up @@ -95,7 +104,6 @@ export function syncRepository(options) {
if (includesValue(features, 'release') && releaseMergeStrategy !== 'rebase') {
throw new Error(`Unsupported release_merge_strategy: ${releaseMergeStrategy || '(unset)'}; release automation requires rebase for Release Please version pull requests and never defaults to merge.`)
}
const license = configured(config.license, existsSync(join(target, 'LICENSE')) ? 'preserve' : 'gpl-3.0-or-later')
const changed = []

// Keep normal semver pins current during sync while preserving intentional
Expand Down Expand Up @@ -179,11 +187,6 @@ export function syncRepository(options) {
}

if (license !== 'preserve' && license !== 'none') {
const licenseFile = licenseFiles[license]
if (!licenseFile) {
const supported = [...Object.keys(licenseFiles), 'preserve', 'none'].join(', ')
throw new Error(`Unsupported license: ${license}; use ${supported}.`)
}
const sourceLicense = join(source, '.github/licenses', licenseFile)
if (!existsSync(sourceLicense)) throw new Error(`License template missing: ${sourceLicense}`)
const licenseContent = readFileSync(sourceLicense)
Expand Down
8 changes: 8 additions & 0 deletions test/cli.test.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -541,6 +541,14 @@ describe('code-foundry CLI', () => {
() => syncRepository({ target: root, source: process.cwd() }),
/Unsupported license: bsd-3-clause; use gpl-3\.0-or-later, agpl-3\.0-or-later, apache-2\.0, mit, preserve, none\./
)
// Validation happens before any writes: the config must not gain default
// additions and no generated baseline files may exist.
assert.equal(
readFileSync(join(root, '.github/code-foundry.yml'), 'utf8'),
'languages: none\npackage_manager: none\nlicense: bsd-3-clause\n'
)
assert.deepEqual(readdirSync(root).sort(), ['.github'])
assert.deepEqual(readdirSync(join(root, '.github')).sort(), ['code-foundry.yml'])
})

it('rejects unsafe Rust CodeQL parallelism configuration', () => {
Expand Down
Loading