ci: update workflows to include license checks and tagging

imranolas · imranolas · commit 0d5d10bb5125 · 2025-05-21T11:38:23.000+01:00
diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
@@ -30,7 +30,10 @@ jobs:
         run: pnpm install
       
       - name: Check
-        run: pnpm nx run-many --target=build,lint,test --parallel=3 --exclude="@storyblok/playground-*"
+        run: pnpm nx run-many --target=build,lint,test --parallel=3 -p="tag:npm:public"
         env:
           VITE_ACCESS_TOKEN: ${{ secrets.VITE_ACCESS_TOKEN }}
           VITE_SPACE_ID: ${{ vars.VITE_SPACE_ID }}
+
+      - name: Check Licenses
+        run: nx exec -p="tag:npm:public" -- pnpm -w monoblok license check \$NX_PROJECT_NAME
diff --git a/.github/workflows/pr-preview.yaml b/.github/workflows/pr-preview.yaml
@@ -31,7 +31,7 @@ jobs:
         run: pnpm install
       
       - name: Build
-        run: pnpm nx run-many --target=build --parallel=5 --exclude="@storyblok/playground-*"
+        run: pnpm nx run-many --target=build --parallel=5 -p="tag:npm:public"
       
       - name: Generate PR version
         id: pr-version
diff --git a/packages/astro/package.json b/packages/astro/package.json
@@ -145,6 +145,9 @@
   "nx": {
     "implicitDependencies": [
       "!@storyblok/playground-*"
+    ],
+    "tags": [
+      "type:lib"
     ]
   }
 }
diff --git a/packages/astro/playground/ssg/package.json b/packages/astro/playground/ssg/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@storyblok/playground-astro-ssg",
   "version": "0.0.0",
+  "private": true,
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
diff --git a/packages/astro/playground/ssr/package.json b/packages/astro/playground/ssr/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@storyblok/playground-astro-ssr",
+  "private": true,
   "version": "0.0.0",
   "scripts": {
     "dev": "astro dev",
diff --git a/packages/astro/playground/test/package.json b/packages/astro/playground/test/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@storyblok/playground-astro-test",
+  "private": true,
   "version": "0.0.0",
   "scripts": {
     "dev": "astro dev",
diff --git a/packages/js/playground/vanilla/package.json b/packages/js/playground/vanilla/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@storyblok/playground-js-vanilla",
+  "private": true,
   "version": "0.0.1",
   "scripts": {
     "dev": "vite",
diff --git a/packages/js/playground/vue/package.json b/packages/js/playground/vue/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@storyblok/playground-js-vue",
   "version": "0.0.0",
+  "private": true,
   "scripts": {
     "dev": "vite",
     "build": "vite build"
diff --git a/packages/react/playground/react/package.json b/packages/react/playground/react/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@storyblok/playground-react-vite",
   "type": "module",
+  "private": true,
   "version": "0.0.1",
   "scripts": {
     "dev": "vite",
diff --git a/packages/richtext/playground/astro/package.json b/packages/richtext/playground/astro/package.json
@@ -1,6 +1,7 @@
 {
   "name": "@storyblok/playground-richtext-astro",
   "type": "module",
+  "private": true,
   "version": "0.0.1",
   "scripts": {
     "dev": "astro dev",
diff --git a/packages/richtext/playground/node/package.json b/packages/richtext/playground/node/package.json
@@ -1,5 +1,6 @@
 {
   "name": "@storyblok/playground-richtext-node",
+  "private": true,
   "version": "1.0.0",
   "description": "",
   "author": "",
diff --git a/packages/richtext/scripts/license-checker.mjs b/packages/richtext/scripts/license-checker.mjs
@@ -32,6 +32,7 @@ licenseChecker.init(
     production: true,
     json: true,
     exclude: EXCLUDED_LICENSES.join(','),
+    allow: 'MIT',
   },
   (err, packages) => {
     if (err) {
diff --git a/packages/storyblok-js-client/playground/svelte/package.json b/packages/storyblok-js-client/playground/svelte/package.json
@@ -4,6 +4,7 @@
   "scripts": {
     "dev": "vite"
   },
+  "private": true,
   "devDependencies": {
     "@sveltejs/vite-plugin-svelte": "^3.1.2",
     "@tsconfig/svelte": "^5.0.4",
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tools/monoblok/package.json b/tools/monoblok/package.json
@@ -14,10 +14,12 @@
     "postinstall": "pnpm run build"
   },
   "dependencies": {
+    "@types/license-checker": "^25.0.6",
     "chalk": "^4.1.2",
     "commander": "^11.1.0",
     "execa": "^5.1.1",
     "inquirer": "^8.2.5",
+    "license-checker": "^25.0.1",
     "ora": "^5.4.1",
     "unbuild": "^3.5.0"
   },
diff --git a/tools/monoblok/src/commands/license/check.ts b/tools/monoblok/src/commands/license/check.ts
@@ -0,0 +1,65 @@
+import { Command } from 'commander';
+import chalk from 'chalk';
+import * as utils from '../../utils';
+import licenseChecker from 'license-checker';
+
+const PERMITTED_LICENSES = [
+  'MIT',
+  'ISC',
+  'Apache-2.0',
+  'BSD-3-Clause',
+  'BSD-2-Clause',
+  'BlueOak-1.0.0',
+  'CC0-1.0',
+  '0BSD',
+  'CC-BY-4.0',
+  'MIT*',
+  'WTFPL',
+  'MIT-0',
+  'Python-2.0',
+  'Public Domain',
+  'CC-BY-3.0',
+  'BSD*',
+  'Unlicense',
+];
+
+export function checkCommand(program: Command): void {
+  program
+    .command('check')
+    .description('Check dependency licenses for a package')
+    .argument('<package>', 'Package name to check')
+    .action(async (packageName: string) => {
+      try {
+        const packagePath = await utils.getPackagePath(packageName);
+
+        licenseChecker.init({
+          start: packagePath,
+          production: true,
+          json: true,
+          // @ts-expect-error license-checker types are not updated
+          exclude: PERMITTED_LICENSES.join(','),
+        }, (err, packages) => {
+          if (err) {
+            console.error(err);
+            process.exit(1);
+          }
+
+          // The remaining packages are the ones that have invalid licenses
+          const packagesWithInvalidLicenses = Object.entries(packages);
+
+          if (packagesWithInvalidLicenses.length > 0) {
+            console.error(chalk.red(`Invalid licenses found for package '${packageName}'`));
+            console.error(packagesWithInvalidLicenses);
+            process.exit(1);
+          }
+          else {
+            console.log(chalk.green(`All licenses are valid for package '${packageName}'`));
+          }
+        });
+      } catch (error) {
+        console.error(chalk.red(`Error checking license for package '${packageName}'`));
+        console.error(error);
+        process.exit(1);
+      }
+    });
+} 
diff --git a/tools/monoblok/src/commands/license/index.ts b/tools/monoblok/src/commands/license/index.ts
@@ -0,0 +1,11 @@
+import { Command } from 'commander';
+import { checkCommand } from './check';
+
+export function licenseCommand(program: Command): void {
+  const license = program
+    .command('license')
+    .description('Manage and check package licenses');
+
+  // Add license-related subcommands
+  checkCommand(license);
+} 
diff --git a/tools/monoblok/src/index.ts b/tools/monoblok/src/index.ts
@@ -1,5 +1,6 @@
 import { Command } from 'commander';
 import { subtreeCommand } from './commands/subtree';
+import { licenseCommand } from './commands/license';
 
 // Create the program
 const program = new Command();
@@ -12,6 +13,7 @@ program
 
 // Register commands
 subtreeCommand(program);
+licenseCommand(program);
 
 // Parse command line arguments
 program.parse(); 
diff --git a/tools/monoblok/src/utils.ts b/tools/monoblok/src/utils.ts
@@ -15,6 +15,16 @@ export interface RepoManifest {
   [packageName: string]: ManifestEntry;
 }
 
+
+
+export interface Package {
+  name: string;
+  path: string;
+  version: string;
+  dependencies: unknown
+  devDependencies: unknown
+}
+
 // Get root directory of the monorepo
 export function getMonorepoRoot(): string {
   return process.cwd();
@@ -112,3 +122,17 @@ export function validateFilteredManifest(
     }
   }
 } 
+
+export async function getPackageList(): Promise<Package[]> {
+  const { stdout } = await execa('pnpm', ['recursive', 'ls', '--json']);
+  return JSON.parse(stdout);
+}
+
+export async function getPackagePath(packageName: string): Promise<string> {
+  const packageList = await getPackageList();
+  const pkg = packageList.find((pkg: any) => pkg.name === packageName);
+  if (!pkg) {
+    throw new Error(`Package ${packageName} not found`);
+  }
+  return pkg.path;
+}

Original file line number	Diff line number	Diff line change
`@@ -145,6 +145,9 @@`
`145`	`145`	`"nx": {`
`146`	`146`	`"implicitDependencies": [`
`147`	`147`	`"!@storyblok/playground-*"`
	`148`	`+ ],`
	`149`	`+ "tags": [`
	`150`	`+ "type:lib"`
`148`	`151`	`]`
`149`	`152`	`}`
`150`	`153`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@storyblok/playground-astro-ssg",`
`3`	`3`	`"version": "0.0.0",`
	`4`	`+ "private": true,`
`4`	`5`	`"scripts": {`
`5`	`6`	`"dev": "astro dev",`
`6`	`7`	`"start": "astro dev",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@storyblok/playground-astro-ssr",`
	`3`	`+ "private": true,`
`3`	`4`	`"version": "0.0.0",`
`4`	`5`	`"scripts": {`
`5`	`6`	`"dev": "astro dev",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@storyblok/playground-astro-test",`
	`3`	`+ "private": true,`
`3`	`4`	`"version": "0.0.0",`
`4`	`5`	`"scripts": {`
`5`	`6`	`"dev": "astro dev",`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@storyblok/playground-js-vanilla",`
	`3`	`+ "private": true,`
`3`	`4`	`"version": "0.0.1",`
`4`	`5`	`"scripts": {`
`5`	`6`	`"dev": "vite",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@storyblok/playground-js-vue",`
`3`	`3`	`"version": "0.0.0",`
	`4`	`+ "private": true,`
`4`	`5`	`"scripts": {`
`5`	`6`	`"dev": "vite",`
`6`	`7`	`"build": "vite build"`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@storyblok/playground-react-vite",`
`3`	`3`	`"type": "module",`
	`4`	`+ "private": true,`
`4`	`5`	`"version": "0.0.1",`
`5`	`6`	`"scripts": {`
`6`	`7`	`"dev": "vite",`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@storyblok/playground-richtext-astro",`
`3`	`3`	`"type": "module",`
	`4`	`+ "private": true,`
`4`	`5`	`"version": "0.0.1",`
`5`	`6`	`"scripts": {`
`6`	`7`	`"dev": "astro dev",`