@pixpilot/scaffoldfy-configs 0.41.0 → 0.43.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @pixpilot/scaffoldfy-configs
 
+## 0.43.0
+
+### Minor Changes
+
+- add GitHub App token release workflow
+
+## 0.42.0
+
+### Minor Changes
+
+- add `--set <key=value>` option for preset prompt answers
+- 0319f19: workspace-initializer: create multiple packages at once from a comma separated list of names
+
 ## 0.41.0
 
 ### Minor Changes

package/README.md

@@ -24,6 +24,16 @@ Usage:
 npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/codeql-private-repo/scaffoldfy.json
 ```
 
+### github-action-release-app-token
+
+Replaces the release workflow of a github-action-template clone with the GitHub App token variant (RELEASER_ID / RELEASER_PRIVATE_KEY) for pixpilot and ccpu repositories
+
+Usage:
+
+```sh
+npx @pixpilot/scaffoldfy@latest --config https://unpkg.com/@pixpilot/scaffoldfy-configs@latest/github-action-release-app-token/scaffoldfy.json
+```
+
 ### license-file
 
 Generate a LICENSE file with common open-source licenses

package/github-action-release-app-token/release.yml

@@ -0,0 +1,50 @@
+name: Release
+
+on:
+  workflow_run:
+    workflows: [CI]
+    types:
+      - completed
+    branches:
+      - main
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    if: >-
+      ${{
+        github.event.workflow_run.conclusion == 'success' &&
+        github.event.workflow_run.event == 'push' &&
+        github.event.workflow_run.head_branch == 'main' &&
+        !contains(github.event.workflow_run.head_commit.message || '', '[skip ci]') &&
+        !contains(github.event.workflow_run.head_commit.message || '', '[ci skip]')
+      }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Generate token
+        id: generate-token
+        uses: actions/create-github-app-token@v3
+        with:
+          client-id: ${{ secrets.RELEASER_ID }}
+          private-key: ${{ secrets.RELEASER_PRIVATE_KEY }}
+
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+          ref: ${{ github.event.workflow_run.head_sha }}
+          token: ${{ steps.generate-token.outputs.token }}
+
+      - name: Setup Project
+        uses: pixpilot/github-actions/setup-pnpm-project@v1
+
+      - name: Build dist
+        run: npm run bundle
+
+      - name: Semantic Release
+        uses: cycjimmy/semantic-release-action@v4
+        env:
+          GITHUB_TOKEN: ${{ steps.generate-token.outputs.token }}

package/github-action-release-app-token/scaffoldfy.json

@@ -0,0 +1,31 @@
+{
+  "$schema": "../node_modules/@pixpilot/scaffoldfy/schema/scaffoldfy.schema.json",
+  "name": "github-action-release-app-token",
+  "description": "Replaces the release workflow of a github-action-template clone with the GitHub App token variant (RELEASER_ID / RELEASER_PRIVATE_KEY) for pixpilot and ccpu repositories",
+  "dependencies": ["pixpilot-info"],
+  "variables": [
+    {
+      "id": "isGithubActionTemplate",
+      "value": {
+        "type": "exec",
+        "value": "node -e \"try{process.stdout.write(String(require(require('path').resolve('package.json')).name==='github-action-template'))}catch{process.stdout.write('false')}\""
+      }
+    }
+  ],
+  "tasks": [
+    {
+      "id": "github-action-release-app-token-workflow",
+      "name": "Use GitHub App token in release workflow",
+      "description": "Overwrites the release workflow to authenticate semantic-release with a GitHub App token",
+      "enabled": {
+        "type": "condition",
+        "value": "isGithubActionTemplate === true && pixpilot_project === true"
+      },
+      "type": "write",
+      "config": {
+        "templateFile": "release.yml",
+        "file": ".github/workflows/release.yml"
+      }
+    }
+  ]
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pixpilot/scaffoldfy-configs",
   "type": "module",
-  "version": "0.41.0",
+  "version": "0.43.0",
   "author": "PixPilot <m.doaie@hotmail.com>",
   "license": "MIT",
   "repository": {
@@ -30,10 +30,10 @@
     "@types/node": "^22.18.11",
     "eslint": "^9.38.0",
     "@internal/eslint-config": "0.3.0",
-    "@internal/prettier-config": "0.0.1",
+    "@internal/vitest-config": "0.1.0",
     "@internal/tsdown-config": "0.1.0",
-    "@pixpilot/scaffoldfy": "0.55.1",
-    "@internal/vitest-config": "0.1.0"
+    "@pixpilot/scaffoldfy": "0.56.0",
+    "@internal/prettier-config": "0.0.1"
   },
   "prettier": "@internal/prettier-config",
   "publishConfig": {

package/test/create-packages.test.ts

@@ -0,0 +1,101 @@
+import { spawnSync } from 'node:child_process';
+import fs from 'node:fs';
+import os from 'node:os';
+import path from 'node:path';
+import process from 'node:process';
+import { afterEach, describe, expect, it } from 'vitest';
+
+const SCRIPT_PATH = path.join(
+  __dirname,
+  '..',
+  'workspace-initializer',
+  'scripts',
+  'create-packages.cjs',
+);
+const temporaryDirectories: string[] = [];
+
+afterEach(() => {
+  for (const directory of temporaryDirectories.splice(0)) {
+    fs.rmSync(directory, { force: true, recursive: true });
+  }
+});
+
+/**
+ * Put a fake `pnpm` on PATH that appends its arguments to a log file
+ */
+function createFakePnpm(): { binDirectory: string; logPath: string } {
+  const testDirectory = fs.mkdtempSync(path.join(os.tmpdir(), 'create-packages-'));
+  temporaryDirectories.push(testDirectory);
+
+  const binDirectory = path.join(testDirectory, 'bin');
+  const logPath = path.join(testDirectory, 'calls.log');
+  const fakePnpmScript = path.join(binDirectory, 'fake-pnpm.cjs');
+  fs.mkdirSync(binDirectory, { recursive: true });
+  fs.writeFileSync(
+    fakePnpmScript,
+    `require('node:fs').appendFileSync(${JSON.stringify(logPath)}, process.argv.slice(2).join(' ') + '\\n');`,
+  );
+
+  if (process.platform === 'win32') {
+    fs.writeFileSync(
+      path.join(binDirectory, 'pnpm.cmd'),
+      `@"${process.execPath}" "${fakePnpmScript}" %*\r\n`,
+    );
+  } else {
+    const pnpmPath = path.join(binDirectory, 'pnpm');
+    fs.writeFileSync(
+      pnpmPath,
+      `#!/bin/sh\n"${process.execPath}" "${fakePnpmScript}" "$@"\n`,
+    );
+    fs.chmodSync(pnpmPath, 0o755);
+  }
+
+  return { binDirectory, logPath };
+}
+
+function runScript(packageNames: string, binDirectory: string) {
+  const pathKey =
+    Object.keys(process.env).find((key) => key.toUpperCase() === 'PATH') ?? 'PATH';
+  return spawnSync(process.execPath, [SCRIPT_PATH], {
+    encoding: 'utf8',
+    env: {
+      ...process.env,
+      [pathKey]: `${binDirectory}${path.delimiter}${process.env[pathKey] ?? ''}`,
+      PACKAGE_NAMES: packageNames,
+    },
+  });
+}
+
+describe('workspace-initializer create-packages script', () => {
+  it('runs the package generator once per comma separated name', () => {
+    const { binDirectory, logPath } = createFakePnpm();
+
+    const result = runScript(' pkg-a, pkg-b ,,@scope/pkg-c ', binDirectory);
+
+    expect(result.status).toBe(0);
+    expect(fs.readFileSync(logPath, 'utf8').trim().split(/\r?\n/u)).toEqual([
+      'run gen:package --set packageBaseName=pkg-a',
+      'run gen:package --set packageBaseName=pkg-b',
+      'run gen:package --set packageBaseName=@scope/pkg-c',
+    ]);
+  });
+
+  it('skips when no names are given', () => {
+    const { binDirectory, logPath } = createFakePnpm();
+
+    const result = runScript(' , ', binDirectory);
+
+    expect(result.status).toBe(0);
+    expect(fs.existsSync(logPath)).toBe(false);
+  });
+
+  it('rejects names with shell characters', () => {
+    const { binDirectory, logPath } = createFakePnpm();
+
+    const result = runScript('pkg-a, bad;rm -rf', binDirectory);
+
+    expect(result.status).toBe(1);
+    expect(result.stderr).toContain('Invalid package name(s): bad;rm -rf');
+    expect(fs.existsSync(logPath)).toBe(false);
+  });
+});

package/workspace-initializer/scaffoldfy.json

@@ -22,8 +22,18 @@
     {
       "id": "createFirstPackagePrompt",
       "type": "confirm",
-      "message": "Create the first package now?",
+      "message": "Create packages now?",
       "default": false
+    },
+    {
+      "id": "packageNames",
+      "type": "input",
+      "message": "Enter package names (comma separated, e.g. my-package, my-other-package)",
+      "required": true,
+      "enabled": {
+        "type": "condition",
+        "value": "createFirstPackagePrompt === true"
+      }
     }
   ],
   "tasks": [
@@ -88,12 +98,19 @@
     },
     {
       "id": "create-first-package",
-      "name": "Create first package",
-      "description": "Generate the first package in the monorepo using the package generator",
-      "type": "exec",
+      "name": "Create packages",
+      "description": "Generate each requested package in the monorepo using the package generator",
+      "type": "exec-file",
+      "enabled": {
+        "type": "condition",
+        "value": "createFirstPackagePrompt === true"
+      },
       "config": {
-        "command": "pnpm run gen:package",
-        "condition": "createFirstPackagePrompt"
+        "file": "./scripts/create-packages.cjs",
+        "runtime": "node",
+        "parameters": {
+          "PACKAGE_NAMES": "{{packageNames}}"
+        }
       }
     },
     {

package/workspace-initializer/scripts/create-packages.cjs

@@ -0,0 +1,46 @@
+#!/usr/bin/env node
+/* eslint-disable node/prefer-global/process */
+/**
+ * Runs the workspace package generator once per package name, pre-filling
+ * the package name prompt so only the remaining prompts are asked.
+ *
+ * Usage:
+ *   PACKAGE_NAMES="pkg-a, pkg-b" node create-packages.cjs
+ */
+
+'use strict';
+
+const { spawnSync } = require('node:child_process');
+
+const SAFE_NAME = /^[\w.@/-]+$/u;
+
+const names = (process.env.PACKAGE_NAMES || '')
+  .split(',')
+  .map((name) => name.trim())
+  .filter(Boolean);
+
+if (names.length === 0) {
+  console.log('No package names provided, skipping package creation.');
+  process.exit(0);
+}
+
+const invalid = names.filter((name) => !SAFE_NAME.test(name));
+if (invalid.length > 0) {
+  console.error(`Invalid package name(s): ${invalid.join(', ')}`);
+  process.exit(1);
+}
+
+for (const [index, name] of names.entries()) {
+  console.log(`\nCreating package ${index + 1}/${names.length}: ${name}\n`);
+
+  const result = spawnSync(
+    'pnpm',
+    ['run', 'gen:package', '--set', `packageBaseName=${name}`],
+    { stdio: 'inherit', shell: true },
+  );
+
+  if (result.status !== 0) {
+    console.error(`Failed to create package: ${name}`);
+    process.exit(result.status ?? 1);
+  }
+}