feat(turbo): add sticky-turbo plan support (#190)

<!--  Thanks for sending a pull request! -->

#### What this PR does / why we need it:

Introduce new `sticky-turbo plan task` to allow planning of tasks before
running them. Built to parallelize CI pipelines for faster PR review
intervals.

1. **Test [plan]**: `pnpm sticky-turbo plan test` >> packages.json
2. **Test [$p]**: `for p packages.json`
   1. `pnpm turbo run test --filter=p --concurency=2`
3. **Test [completed]**: for "Branch Protection: Require status checks
to pass before merging"

.github/workflows/ci.yml

@@ -27,7 +27,8 @@ jobs:
 
       - run: pnpm build
 
-  Test:
+  lint_prettier:
+    name: Lint [prettier]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
@@ -40,15 +41,31 @@ jobs:
           cache: pnpm
 
       - run: pnpm install --frozen-lockfile
-      - run: pnpm test -- -- --maxWorkers=100% --coverage
 
-      - uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
+      - run: pnpm prettier --check .
+
+  lint_eslint:
+    name: Lint [eslint]
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+
+      - run: corepack enable pnpm
+
+      - uses: actions/setup-node@64ed1c7eab4cce3362f8c340dee64e5eaeef8f7c # v3.6.0
         with:
-          fail_ci_if_error: true
+          node-version-file: '.nvmrc'
+          cache: pnpm
 
-  lint_prettier:
-    name: Lint (prettier)
+      - run: pnpm install --frozen-lockfile
+
+      - run: pnpm turbo run lint
+
+  test_plan:
+    name: Test [plan]
     runs-on: ubuntu-latest
+    outputs:
+      packages: ${{ steps.plan.outputs.packages }}
     steps:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
 
@@ -61,11 +78,23 @@ jobs:
 
       - run: pnpm install --frozen-lockfile
 
-      - run: pnpm prettier --check .
+      # this step is only required in this repo because the cli source is not yet built
+      - run: pnpm turbo run build --filter=@stickyjs/turbo
 
-  lint_eslint:
-    name: Lint (eslint)
+      - id: plan
+        run: |
+          echo 'packages<<EOF' >> $GITHUB_OUTPUT
+          pnpm sticky-turbo plan test >> $GITHUB_OUTPUT
+          echo 'EOF' >> $GITHUB_OUTPUT
+
+  test_run:
+    name: Test [run]
     runs-on: ubuntu-latest
+    needs: test_plan
+    strategy:
+      fail-fast: false
+      matrix:
+        package: ${{ fromJSON(needs.test_plan.outputs.packages) }}
     steps:
       - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
 
@@ -78,4 +107,17 @@ jobs:
 
       - run: pnpm install --frozen-lockfile
 
-      - run: pnpm turbo run lint
+      - run: pnpm turbo run test --concurrency=1 --filter=${{ matrix.package }} -- --coverage --forceExit
+
+      - uses: codecov/codecov-action@eaaf4bedf32dbdc6b720b63067d99c4d77d6047d # v3.1.4
+
+  test_completed:
+    name: Test [completed]
+    runs-on: ubuntu-latest
+    needs: test_run
+    if: always()
+    steps:
+      - run: |
+          if ${{ contains(needs.*.result, 'failure') || contains(needs.*.result, 'skipped') || contains(needs.*.result, 'cancelled') }} ; then
+            exit 1
+          fi

.github/workflows/oss-governance-bot.yml

@@ -1,4 +1,4 @@
-name: OSS Governance
+name: OSS
 
 on:
   pull_request_target:
@@ -16,7 +16,8 @@ permissions:
   checks: write
 
 jobs:
-  Bot:
+  main:
+    name: Governance Bot
     runs-on: ubuntu-latest
     steps:
       - uses: BirthdayResearch/oss-governance-bot@37c8583c6b8596d173b68ffaed543e2485f4f193 # v3.0.0

.github/workflows/oss-governance-labeler.yml

@@ -1,4 +1,4 @@
-name: OSS Governance
+name: OSS
 
 on:
   pull_request_target:

.github/workflows/oss-governance-labels.yml

@@ -1,4 +1,4 @@
-name: OSS Governance
+name: OSS
 
 on:
   push:

packages/turbo/cli.js

@@ -0,0 +1,3 @@
+#! /usr/bin/env node
+/* eslint-disable */
+require('./dist/cli.js');

packages/turbo/package.json

@@ -7,6 +7,9 @@
   "main": "./dist/index.js",
   "source": "./src/index.ts",
   "types": "./dist/index.d.ts",
+  "bin": {
+    "sticky-turbo": "./cli.js"
+  },
   "files": [
     "dist/**"
   ],
@@ -36,6 +39,9 @@
   "jest": {
     "preset": "@stickyjs/jest"
   },
+  "dependencies": {
+    "clipanion": "3.2.1"
+  },
   "devDependencies": {
     "@stickyjs/jest": "workspace:*",
     "turbo": "1.10.6"

packages/turbo/src/TurboPlanCommand.ts

@@ -0,0 +1,30 @@
+import { Command, Option } from 'clipanion';
+import * as process from 'process';
+
+import { Turbo } from './Turbo';
+
+/**
+ * Running `sticky-turbo plan test` generate a list of packages that contains a `test` script in the package.
+ * You can use the output and loop through an array to run test individually via `turbo run test --filter=package`
+ */
+export class TurboPlanCommand extends Command {
+  static override paths = [[`plan`]];
+
+  task = Option.String({ required: true });
+
+  scope = Option.Boolean('--scope', true, {
+    description: 'Include scope in the package name, default to true',
+  });
+
+  async execute(): Promise<void> {
+    const turbo = new Turbo(process.cwd());
+    const packages = turbo.planPackages(this.task).map((name) => {
+      if (this.scope) {
+        return name;
+      }
+      return name.replace(/^@[^/]+\//, '');
+    });
+    this.context.stdout.write(`${JSON.stringify(packages, null, 2)}`);
+    this.context.stdout.write('\n');
+  }
+}

packages/turbo/src/cli.ts

@@ -0,0 +1,6 @@
+import { runExit } from 'clipanion';
+
+import { TurboPlanCommand } from './TurboPlanCommand';
+
+// noinspection JSIgnoredPromiseFromCall
+void runExit([TurboPlanCommand]);

packages/turbo/turbo.json

@@ -0,0 +1,4 @@
+{
+  "extends": ["//"],
+  "pipeline": {}
+}