From 0d7ec2763d7f8a2d0848408f4f9ee8bad412e58e Mon Sep 17 00:00:00 2001 From: NiftyAndy Date: Mon, 3 Aug 2026 19:49:51 -0400 Subject: [PATCH 1/2] feat: support Apache 2.0 license sync --- .github/licenses/APACHE-2.0.txt | 201 ++++++++++++++++++++++++++++++++ docs/CONFIGURATION.md | 2 +- src/commands/sync.mjs | 14 ++- test/cli.test.mjs | 41 +++++++ 4 files changed, 256 insertions(+), 2 deletions(-) create mode 100644 .github/licenses/APACHE-2.0.txt diff --git a/.github/licenses/APACHE-2.0.txt b/.github/licenses/APACHE-2.0.txt new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/.github/licenses/APACHE-2.0.txt @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/docs/CONFIGURATION.md b/docs/CONFIGURATION.md index 76e011e..f238481 100644 --- a/docs/CONFIGURATION.md +++ b/docs/CONFIGURATION.md @@ -46,7 +46,7 @@ repository manifests and source | `runtime_ref` | tag or branch | Reusable workflow version | | `release_type` | `node`, `python`, `rust`, `simple`, `none` | Release strategy | | `npm_publish` | `true` or `false` | Opt into npm publication | -| `license` | `gpl-3.0-or-later`, `agpl-3.0-or-later`, `mit`, `preserve`, `none` | License policy; new repositories default to GPLv3 | +| `license` | `gpl-3.0-or-later`, `agpl-3.0-or-later`, `apache-2.0`, `mit`, `preserve`, `none` | License policy; new repositories default to GPLv3 | | `git_workflow` | `staging-release` | Branch/release model; the standard model promotes `staging` into `main` | | `merge_strategy` | `rebase` | Promotion merge method for `staging` → `main`; the staging-release topology requires rebase | | `release_merge_strategy` | `rebase` | Merge method for Release Please version PRs into `main`; release automation fails closed unless rebase | diff --git a/src/commands/sync.mjs b/src/commands/sync.mjs index 9288ff4..a33d639 100644 --- a/src/commands/sync.mjs +++ b/src/commands/sync.mjs @@ -33,6 +33,14 @@ const protectedFiles = new Set([ '.github/PULL_REQUEST_TEMPLATE.md', '.github/SECURITY.md', 'NOTICE', ]) +/** @type {Record} */ +const licenseFiles = { + 'gpl-3.0-or-later': 'GPL-3.0-or-later.txt', + 'agpl-3.0-or-later': 'AGPL-3.0-or-later.txt', + 'apache-2.0': 'APACHE-2.0.txt', + 'mit': 'MIT.txt', +} + const legacyFiles = [ '.github/code-foundry.yml.example', '.github/template.yml', '.github/template.yml.example', '.github/scripts/bootstrap.sh', '.github/scripts/changed-files.sh', '.github/scripts/ci.sh', @@ -171,7 +179,11 @@ export function syncRepository(options) { } if (license !== 'preserve' && license !== 'none') { - const licenseFile = license === 'mit' ? 'MIT.txt' : license === 'agpl-3.0-or-later' ? 'AGPL-3.0-or-later.txt' : 'GPL-3.0-or-later.txt' + 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) diff --git a/test/cli.test.mjs b/test/cli.test.mjs index 92f6a9f..840d3b2 100644 --- a/test/cli.test.mjs +++ b/test/cli.test.mjs @@ -502,6 +502,47 @@ describe('code-foundry CLI', () => { doctor(root) }) + it('installs the Apache 2.0 license for consumers configured with apache-2.0', () => { + const root = mkdtempSync(join(tmpdir(), 'code-foundry-apache-license-')) + mkdirSync(join(root, '.github'), { recursive: true }) + writeFileSync( + join(root, '.github/code-foundry.yml'), + [ + 'languages: none', + 'package_manager: none', + 'license: apache-2.0', + '', + ].join('\n') + ) + + syncRepository({ target: root, source: process.cwd() }) + const license = readFileSync(join(root, 'LICENSE'), 'utf8') + assert.match(license, /Apache License/) + assert.match(license, /Version 2\.0, January 2004/) + assert.match(license, /TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION/) + assert.doesNotMatch(license, /GNU/) + assert.match(readFileSync(join(root, '.github/code-foundry.yml'), 'utf8'), /license: apache-2\.0/) + }) + + it('rejects unsupported license policies with the supported list', () => { + const root = mkdtempSync(join(tmpdir(), 'code-foundry-license-policy-')) + mkdirSync(join(root, '.github'), { recursive: true }) + writeFileSync( + join(root, '.github/code-foundry.yml'), + [ + 'languages: none', + 'package_manager: none', + 'license: bsd-3-clause', + '', + ].join('\n') + ) + + assert.throws( + () => 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\./ + ) + }) + it('rejects unsafe Rust CodeQL parallelism configuration', () => { const root = mkdtempSync(join(tmpdir(), 'code-foundry-codeql-config-')) mkdirSync(join(root, '.github'), { recursive: true }) From 2f65411af2c6d6c83bc1ff62f47fe6f924f79d78 Mon Sep 17 00:00:00 2001 From: NiftyAndy Date: Mon, 3 Aug 2026 19:55:38 -0400 Subject: [PATCH 2/2] fix: validate license policy before sync --- src/commands/sync.mjs | 15 +++++++++------ test/cli.test.mjs | 8 ++++++++ 2 files changed, 17 insertions(+), 6 deletions(-) diff --git a/src/commands/sync.mjs b/src/commands/sync.mjs index a33d639..23aad3c 100644 --- a/src/commands/sync.mjs +++ b/src/commands/sync.mjs @@ -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 { @@ -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 @@ -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) diff --git a/test/cli.test.mjs b/test/cli.test.mjs index 840d3b2..1ce3627 100644 --- a/test/cli.test.mjs +++ b/test/cli.test.mjs @@ -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', () => {