@codedrifters/configulator 0.0.100 → 0.0.101
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +18 -0
- package/lib/index.d.mts +5 -4
- package/lib/index.d.ts +5 -4
- package/lib/index.js +1 -1
- package/lib/index.js.map +1 -1
- package/lib/index.mjs +1 -1
- package/lib/index.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -533,10 +533,28 @@ interface MonorepoProjectOptions {
|
|
|
533
533
|
version?: string;
|
|
534
534
|
pnpmWorkspaceOptions?: PnpmWorkspaceOptions;
|
|
535
535
|
};
|
|
536
|
+
upgradeConfigulatorTask?: boolean; // Default: false — see below
|
|
537
|
+
upgradeConfigulatorTaskOptions?: UpgradeDependenciesOptions;
|
|
536
538
|
// ... all TypeScriptProjectOptions
|
|
537
539
|
}
|
|
538
540
|
```
|
|
539
541
|
|
|
542
|
+
#### Configulator upgrade workflow (default: off)
|
|
543
|
+
|
|
544
|
+
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.
|
|
545
|
+
|
|
546
|
+
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.):
|
|
547
|
+
|
|
548
|
+
```typescript
|
|
549
|
+
const project = new MonorepoProject({
|
|
550
|
+
name: 'my-monorepo',
|
|
551
|
+
upgradeConfigulatorTask: true,
|
|
552
|
+
upgradeConfigulatorTaskOptions: {
|
|
553
|
+
workflowOptions: { schedule: UpgradeDependenciesSchedule.DAILY },
|
|
554
|
+
},
|
|
555
|
+
});
|
|
556
|
+
```
|
|
557
|
+
|
|
540
558
|
### TypeScriptProjectOptions
|
|
541
559
|
|
|
542
560
|
Extends Projen's `TypeScriptProjectOptions` with CodeDrifters defaults. See the [TypeScriptProject](#typescriptproject) section for details.
|
package/lib/index.d.mts
CHANGED
|
@@ -1220,11 +1220,12 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
|
|
|
1220
1220
|
pnpmWorkspaceOptions?: PnpmWorkspaceOptions;
|
|
1221
1221
|
};
|
|
1222
1222
|
/**
|
|
1223
|
-
* Turn on
|
|
1224
|
-
* @codedrifters/configulator
|
|
1225
|
-
*
|
|
1223
|
+
* Turn on a dedicated workflow that upgrades only
|
|
1224
|
+
* @codedrifters/configulator on a schedule (e.g. nightly). When false or
|
|
1225
|
+
* unset, rely on projen's default upgrade workflow for all dependency
|
|
1226
|
+
* upgrades instead.
|
|
1226
1227
|
*
|
|
1227
|
-
* @default
|
|
1228
|
+
* @default false
|
|
1228
1229
|
*/
|
|
1229
1230
|
readonly upgradeConfigulatorTask?: boolean;
|
|
1230
1231
|
/**
|
package/lib/index.d.ts
CHANGED
|
@@ -1269,11 +1269,12 @@ interface MonorepoProjectOptions extends Omit<TypeScriptProjectOptions$1, "defau
|
|
|
1269
1269
|
pnpmWorkspaceOptions?: PnpmWorkspaceOptions;
|
|
1270
1270
|
};
|
|
1271
1271
|
/**
|
|
1272
|
-
* Turn on
|
|
1273
|
-
* @codedrifters/configulator
|
|
1274
|
-
*
|
|
1272
|
+
* Turn on a dedicated workflow that upgrades only
|
|
1273
|
+
* @codedrifters/configulator on a schedule (e.g. nightly). When false or
|
|
1274
|
+
* unset, rely on projen's default upgrade workflow for all dependency
|
|
1275
|
+
* upgrades instead.
|
|
1275
1276
|
*
|
|
1276
|
-
* @default
|
|
1277
|
+
* @default false
|
|
1277
1278
|
*/
|
|
1278
1279
|
readonly upgradeConfigulatorTask?: boolean;
|
|
1279
1280
|
/**
|
package/lib/index.js
CHANGED
|
@@ -1391,7 +1391,7 @@ var MonorepoProject = class extends import_typescript.TypeScriptAppProject {
|
|
|
1391
1391
|
);
|
|
1392
1392
|
this.gitignore?.addPatterns(".DS_Store");
|
|
1393
1393
|
this.addDevDeps("constructs@catalog:");
|
|
1394
|
-
if (options.upgradeConfigulatorTask
|
|
1394
|
+
if (options.upgradeConfigulatorTask === true) {
|
|
1395
1395
|
this.upgradeConfigulatorTask = new import_javascript2.UpgradeDependencies(
|
|
1396
1396
|
this,
|
|
1397
1397
|
(0, import_ts_deepmerge2.merge)(
|