Skip to content

SRE-978: Require a license file per Cargo.toml and pyproject.toml directory #9424

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
TimDiekmann merged 1 commit into from
Aug 31, 2026
Merged

SRE-978: Require a license file per Cargo.toml and pyproject.toml directory #9424

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
63 changes: 37 additions & 26 deletions libs/@local/repo-chores/node/scripts/check-license-in-workspaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,31 +5,47 @@ import { globby } from "globby";

import { getWorkspaceInfoLookup, monorepoRootDirPath } from "./shared/monorepo";

const ignoredDirGlobs = [
"**/dist/**",
"**/node_modules/**",
"**/runner_venv/**",
"**/target/**",
"**/venv/**",
"**/.venv/**",
];

const cargoAndPyprojectGlobs = ["**/Cargo.toml", "**/pyproject.toml"];

const script = async () => {
console.log("Checking license files in Yarn workspaces...");
console.log("Checking license files in package directories...");

const yarnWorkspaceInfoLookup = await getWorkspaceInfoLookup();

const yarnWorkspaceDirPaths = [
monorepoRootDirPath,
...Object.entries(yarnWorkspaceInfoLookup).map(([, yarnWorkspaceInfo]) =>
path.resolve(monorepoRootDirPath, yarnWorkspaceInfo.location),
),
];
const cargoAndPyprojectFilePaths = await globby(cargoAndPyprojectGlobs, {
absolute: true,
cwd: monorepoRootDirPath,
dot: true,
ignore: ignoredDirGlobs,
});

const packageDirPaths = [
...new Set([
monorepoRootDirPath,
...Object.entries(yarnWorkspaceInfoLookup).map(([, yarnWorkspaceInfo]) =>
path.resolve(monorepoRootDirPath, yarnWorkspaceInfo.location),
),
...cargoAndPyprojectFilePaths.map((manifestFilePath) =>
path.dirname(manifestFilePath),
),
]),
].sort();

const licenseFilePaths = await globby("**/licen{c,s}e*", {
absolute: true,
caseSensitiveMatch: false,
cwd: monorepoRootDirPath,
dot: true,
ignore: [
"**/dist/**",
"**/node_modules/**",
"**/runner_venv/**",
"**/target/**",
"**/venv/**",
"**/.venv/**",
],
ignore: ignoredDirGlobs,
});

const misspelledLicenseFileSet = new Set<string>();
Expand All @@ -45,18 +61,13 @@ const script = async () => {

let checkFailed = false;

for (const yarnWorkspaceDirPath of yarnWorkspaceDirPaths) {
const canonicalLicenseFilePath = path.resolve(
yarnWorkspaceDirPath,
"LICENSE.md",
);
for (const packageDirPath of packageDirPaths) {
const canonicalLicenseFilePath = path.resolve(packageDirPath, "LICENSE.md");

const currentLicenseFilePaths = licenseFilePaths.filter(
(licenseFilePath) =>
licenseFilePath.startsWith(yarnWorkspaceDirPath) &&
!licenseFilePath
.slice(yarnWorkspaceDirPath.length + 1)
.includes(path.sep),
licenseFilePath.startsWith(packageDirPath) &&
!licenseFilePath.slice(packageDirPath.length + 1).includes(path.sep),
);

let canonicalLicenseFilePathIsPresent = false;
Expand Down Expand Up @@ -130,15 +141,15 @@ const script = async () => {
if (checkFailed) {
console.log(
chalk.red(
"Please make sure that each Yarn workspace has a LICENSE.md file. Additional license files need to be named as LICENSE-*.md (all caps)",
"Each directory holding a package.json, Cargo.toml or pyproject.toml needs a LICENSE.md file. Additional license files need to be named as LICENSE-*.md (all caps)",
),
);
}

if (extraLicenseFilesArePresent) {
console.log(
chalk.yellow(
"You may want to delete or relocate extra license files which are not located in Yarn workspaces",
"You may want to delete or relocate extra license files which are not located in package directories",
),
);
}
Expand Down
Loading