@codedrifters/configulator 0.0.129 → 0.0.131

package/README.md

@@ -532,28 +532,10 @@ interface MonorepoProjectOptions {
     version?: string;
     pnpmWorkspaceOptions?: PnpmWorkspaceOptions;
   };
-  upgradeConfigulatorTask?: boolean; // Default: false — see below
-  upgradeConfigulatorTaskOptions?: UpgradeDependenciesOptions;
   // ... all TypeScriptProjectOptions
 }
 ```
 
-#### Configulator upgrade workflow (default: off)
-
-By default, `MonorepoProject` does **not** add a separate workflow that upgrades only `@codedrifters/configulator`. Monorepos that use configulator should rely on projen's built-in **upgrade** workflow for all dependency upgrades (including configulator), so there is one source of truth and no duplicate or conflicting automation.
-
-To opt in to a dedicated scheduled workflow that upgrades only `@codedrifters/configulator` (e.g. nightly), set `upgradeConfigulatorTask: true` and optionally customize with `upgradeConfigulatorTaskOptions` (schedule, etc.):
-
-```typescript
-const project = new MonorepoProject({
-  name: 'my-monorepo',
-  upgradeConfigulatorTask: true,
-  upgradeConfigulatorTaskOptions: {
-    workflowOptions: { schedule: UpgradeDependenciesSchedule.DAILY },
-  },
-});
-```
-
 ### TypeScriptProjectOptions
 
 Extends Projen's `TypeScriptProjectOptions` with CodeDrifters defaults. See the [TypeScriptProject](#typescriptproject) section for details.

package/lib/index.d.mts

@@ -4,9 +4,9 @@ import { AwsStageType, DeploymentTargetRoleType, AwsEnvironmentType, AWS_STAGE_T
 import * as spec from '@jsii/spec';
 import { TypeScriptProject as TypeScriptProject$1, TypeScriptAppProject, TypeScriptProjectOptions as TypeScriptProjectOptions$1 } from 'projen/lib/typescript';
 import { ValueOf } from 'type-fest';
-import { NodeProject, UpgradeDependencies, UpgradeDependenciesOptions } from 'projen/lib/javascript';
 import { Component as Component$1, Project as Project$1, Task } from 'projen/lib';
 import { BuildWorkflowOptions, BuildWorkflow } from 'projen/lib/build';
+import { NodeProject } from 'projen/lib/javascript';
 import { JobStep } from 'projen/lib/github/workflows-model';
 
 /*******************************************************************************
@@ -1301,21 +1301,6 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
          */
         pnpmWorkspaceOptions?: PnpmWorkspaceOptions;
     };
-    /**
-     * Turn on a dedicated workflow that upgrades only
-     * @codedrifters/configulator on a schedule (e.g. nightly). When false or
-     * unset, rely on projen's default upgrade workflow for all dependency
-     * upgrades instead.
-     *
-     * @default false
-     */
-    readonly upgradeConfigulatorTask?: boolean;
-    /**
-     * Options for the upgrade configurator task.
-     *
-     * @default: daily schedule
-     */
-    readonly upgradeConfigulatorTaskOptions?: UpgradeDependenciesOptions;
     /**
      * When set, adds the approve-and-merge-upgrade workflow (ADR 0001 §2).
      * Uses a second GitHub App to approve and merge the dependency-upgrade PR
@@ -1325,6 +1310,14 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
      * @see ApproveMergeUpgradeOptions
      */
     readonly approveMergeUpgradeOptions?: ApproveMergeUpgradeOptions;
+    /**
+     * Whether this monorepo consumes @codedrifters/configulator from a registry (npm).
+     * When true, the upgrade workflow adds steps to sync configulator and synthesize.
+     * Set to false when configulator is developed in this repo (e.g. workspace dependency).
+     *
+     * @default true
+     */
+    readonly configulatorRegistryConsumer?: boolean;
 }
 declare class MonorepoProject extends TypeScriptAppProject {
     /**
@@ -1332,11 +1325,9 @@ declare class MonorepoProject extends TypeScriptAppProject {
      */
     readonly pnpmVersion: string;
     /**
-     * Optional task that will attempt to upgrade the @codedrifters/configulator
-     * package version nightly. This keeps the project up-to-date with the latest
-     * official CodeDrifters configs.
+     * Whether this monorepo consumes configulator from a registry (drives upgrade workflow steps).
      */
-    readonly upgradeConfigulatorTask?: UpgradeDependencies;
+    readonly configulatorRegistryConsumer: boolean;
     constructor(userOptions: MonorepoProjectOptions);
     /**
      * Allows a sub project to request installation of dependency at the Monorepo root

package/lib/index.d.ts

@@ -3,9 +3,9 @@ import { AwsCdkTypeScriptApp } from 'projen/lib/awscdk';
 import * as spec from '@jsii/spec';
 import { TypeScriptProject as TypeScriptProject$1, TypeScriptAppProject, TypeScriptProjectOptions as TypeScriptProjectOptions$1 } from 'projen/lib/typescript';
 import { ValueOf } from 'type-fest';
-import { UpgradeDependencies, UpgradeDependenciesOptions, NodeProject } from 'projen/lib/javascript';
 import { Task, Component as Component$1, Project as Project$1 } from 'projen/lib';
 import { BuildWorkflow, BuildWorkflowOptions } from 'projen/lib/build';
+import { NodeProject } from 'projen/lib/javascript';
 import { JobStep } from 'projen/lib/github/workflows-model';
 
 /**
@@ -1350,21 +1350,6 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
          */
         pnpmWorkspaceOptions?: PnpmWorkspaceOptions;
     };
-    /**
-     * Turn on a dedicated workflow that upgrades only
-     * @codedrifters/configulator on a schedule (e.g. nightly). When false or
-     * unset, rely on projen's default upgrade workflow for all dependency
-     * upgrades instead.
-     *
-     * @default false
-     */
-    readonly upgradeConfigulatorTask?: boolean;
-    /**
-     * Options for the upgrade configurator task.
-     *
-     * @default: daily schedule
-     */
-    readonly upgradeConfigulatorTaskOptions?: UpgradeDependenciesOptions;
     /**
      * When set, adds the approve-and-merge-upgrade workflow (ADR 0001 §2).
      * Uses a second GitHub App to approve and merge the dependency-upgrade PR
@@ -1374,6 +1359,14 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
      * @see ApproveMergeUpgradeOptions
      */
     readonly approveMergeUpgradeOptions?: ApproveMergeUpgradeOptions;
+    /**
+     * Whether this monorepo consumes @codedrifters/configulator from a registry (npm).
+     * When true, the upgrade workflow adds steps to sync configulator and synthesize.
+     * Set to false when configulator is developed in this repo (e.g. workspace dependency).
+     *
+     * @default true
+     */
+    readonly configulatorRegistryConsumer?: boolean;
 }
 declare class MonorepoProject extends TypeScriptAppProject {
     /**
@@ -1381,11 +1374,9 @@ declare class MonorepoProject extends TypeScriptAppProject {
      */
     readonly pnpmVersion: string;
     /**
-     * Optional task that will attempt to upgrade the @codedrifters/configulator
-     * package version nightly. This keeps the project up-to-date with the latest
-     * official CodeDrifters configs.
+     * Whether this monorepo consumes configulator from a registry (drives upgrade workflow steps).
      */
-    readonly upgradeConfigulatorTask?: UpgradeDependencies;
+    readonly configulatorRegistryConsumer: boolean;
     constructor(userOptions: MonorepoProjectOptions);
     /**
      * Allows a sub project to request installation of dependency at the Monorepo root

package/lib/index.js

@@ -1457,6 +1457,7 @@ function addBuildCompleteJob(buildWorkflow) {
 }
 
 // src/projects/monorepo-project.ts
+var CONFIGULATOR_PACKAGE_NAME = "@codedrifters/configulator";
 var postInstallDependenciesMap = /* @__PURE__ */ new WeakMap();
 var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
   constructor(userOptions) {
@@ -1528,6 +1529,10 @@ var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
        * Default PNPM version to use in the monorepo.
        */
       pnpmVersion: VERSION.PNPM_VERSION,
+      /**
+       * By default treat as a registry consumer (upgrade workflow syncs configulator).
+       */
+      configulatorRegistryConsumer: true,
       /**
        * We don't want sample code generated for the root project.
        */
@@ -1542,9 +1547,12 @@ var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
       release: false,
       /**
        * Uppgrade dependencies automatically unless otherwise instructed.
+       * Exclude @codedrifters/configulator so the default upgrade task does not
+       * upgrade it (version is often managed in-repo or via a separate sync step).
        */
       depsUpgrade: true,
       depsUpgradeOptions: {
+        exclude: ["@codedrifters/configulator"],
         workflowOptions: {
           schedule: import_javascript3.UpgradeDependenciesSchedule.DAILY
         },
@@ -1631,6 +1639,7 @@ var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
     super({ ...options });
     postInstallDependenciesMap.set(this, []);
     this.pnpmVersion = options.pnpmVersion;
+    this.configulatorRegistryConsumer = options.configulatorRegistryConsumer ?? true;
     new VSCodeConfig(this);
     new PnpmWorkspace(this, options.pnpmOptions?.pnpmWorkspaceOptions);
     if (options.turbo) {
@@ -1675,29 +1684,36 @@ var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
     );
     this.gitignore?.addPatterns(".DS_Store", "test-reports");
     this.addDevDeps("constructs@catalog:");
-    if (options.upgradeConfigulatorTask === true) {
-      this.upgradeConfigulatorTask = new import_javascript3.UpgradeDependencies(
-        this,
-        (0, import_ts_deepmerge2.merge)(
-          {
-            include: ["@codedrifters/configulator"],
-            taskName: `upgrade-codedrifters-configulator`,
-            workflowOptions: {
-              schedule: import_javascript3.UpgradeDependenciesSchedule.DAILY
-            }
-          },
-          options.upgradeConfigulatorTaskOptions ?? {}
-        )
-      );
-    }
     if (options.approveMergeUpgradeOptions) {
       addApproveMergeUpgradeWorkflow(this, options.approveMergeUpgradeOptions);
     }
     if (this.buildWorkflow) {
       addBuildCompleteJob(this.buildWorkflow);
     }
-    this.tasks.tryFind("post-upgrade")?.exec("pnpm upgrade -r");
-    this.tasks.tryFind("post-upgrade")?.spawn(this.defaultTask);
+    const upgradeWorkflow = this.github?.tryFindWorkflow("upgrade");
+    const upgradeJob = upgradeWorkflow?.getJob("upgrade");
+    const jobWithSteps = upgradeJob && "steps" in upgradeJob ? upgradeJob : void 0;
+    if (jobWithSteps?.steps && Array.isArray(jobWithSteps.steps)) {
+      const insertIndex = 4;
+      if (this.configulatorRegistryConsumer) {
+        jobWithSteps.steps.splice(insertIndex, 0, {
+          name: `Sync ${CONFIGULATOR_PACKAGE_NAME} in workspace`,
+          run: `pnpm update -r ${CONFIGULATOR_PACKAGE_NAME}`
+        });
+        jobWithSteps.steps.splice(insertIndex + 1, 0, {
+          name: "Synthesize",
+          run: this.runTaskCommand(this.defaultTask)
+        });
+      }
+      jobWithSteps.steps.splice(
+        insertIndex + (this.configulatorRegistryConsumer ? 2 : 0),
+        0,
+        {
+          name: "Run subproject upgrades",
+          run: "pnpm -r run upgrade"
+        }
+      );
+    }
   }
   /**
    * Allows a sub project to request installation of dependency at the Monorepo root