fix: allow dep upgrade options (#842)

* Fix dependencies not working

* Revert cron job time

---------

Co-authored-by: Leonardo Gama <[email protected]>

Author: Leo10Gama

.projenrc.ts

@@ -1,4 +1,3 @@
-import { UpgradeDependenciesSchedule } from 'projen/lib/javascript';
 import { generateCdkCommonOptions } from './projenrc/cdk-common-options';
 import { generateCdkConstructLibraryOptions } from './projenrc/cdk-construct-library-options';
 import { generateCdkJsiiOptions } from './projenrc/cdk-jsii-options';
@@ -20,11 +19,6 @@ const project = new CdklabsJsiiProject({
   cdklabsPublishingDefaults: false,
   upgradeCdklabsProjenProjectTypes: false, // that is this project!
   setNodeEngineVersion: false,
-  depsUpgradeOptions: {
-    workflowOptions: {
-      schedule: UpgradeDependenciesSchedule.WEEKLY,
-    },
-  },
   peerDependencyOptions: {
     pinnedDevDependency: false,
   },

API.md

@@ -23,10 +23,6 @@ export function generateCdkConstructLibraryOptions(project: typescript.TypeScrip
         },
       },
     },
-    omitProps: [
-      // These properties are ignored; a CdkLabsConstructLibrary does what it wants anyway.
-      'depsUpgrade', 'depsUpgradeOptions',
-    ],
     properties: [
       ...COMMON_OPTIONS,
       {

projenrc/cdk-construct-library-options.ts

@@ -64,7 +64,7 @@ export function withCommonOptionsDefaults<T extends ProjectOptions>(options: T):
   return deepMerge([{}, options, common]) as T & ConfiguredCommonOptions;
 }
 
-export function configureCommonComponents(project: typescript.TypeScriptProject, opts: CdkCommonOptions & Pick<javascript.NodeProjectOptions, 'autoApproveUpgrades' | 'autoApproveOptions'>) {
+export function configureCommonComponents(project: typescript.TypeScriptProject, opts: CdkCommonOptions & Pick<javascript.NodeProjectOptions, 'autoApproveUpgrades' | 'autoApproveOptions' | 'depsUpgradeOptions'>) {
   if (opts.private) {
     new Private(project);
   }
@@ -86,6 +86,13 @@ export function configureCommonComponents(project: typescript.TypeScriptProject,
     // Run at 18:00Z once a week (on Monday)
     const upgradeSchedule = javascript.UpgradeDependenciesSchedule.expressions(['0 18 * * 1']);
 
+    // Get branch configuration from depsUpgradeOptions if available
+    const workflowOptions = {
+      labels,
+      schedule: upgradeSchedule,
+      ...(opts.depsUpgradeOptions?.workflowOptions ?? {}),
+    };
+
     new javascript.UpgradeDependencies(project, {
       taskName: 'upgrade',
       // NOTE: we explicitly do NOT upgrade PEER dependencies. We want the widest range of compatibility possible,
@@ -95,10 +102,7 @@ export function configureCommonComponents(project: typescript.TypeScriptProject,
       types: [DependencyType.RUNTIME, DependencyType.BUNDLED],
       exclude,
       semanticCommit: 'fix',
-      workflowOptions: {
-        labels,
-        schedule: upgradeSchedule,
-      },
+      workflowOptions,
     });
 
     new javascript.UpgradeDependencies(project, {
@@ -107,10 +111,7 @@ export function configureCommonComponents(project: typescript.TypeScriptProject,
       exclude,
       semanticCommit: 'chore',
       pullRequestTitle: 'upgrade dev dependencies',
-      workflowOptions: {
-        labels,
-        schedule: upgradeSchedule,
-      },
+      workflowOptions,
     });
   }
 

src/cdk-construct-library-options.ts

@@ -219,6 +219,46 @@ describe('CdklabsConstructLibrary', () => {
       expect(workflow).toMatchSnapshot();
     });
   });
+
+  test('respects branch configuration with custom upgrade tasks', () => {
+    const testBranches = ['branch1/main', 'branch2/main'];
+
+    const project = new TestCdkLabsConstructLibrary({
+      depsUpgradeOptions: {
+        workflowOptions: {
+          branches: testBranches,
+        },
+      },
+    });
+
+    const outdir = Testing.synth(project);
+    // Verify upgrade workflows exist in the outdir
+    expect(outdir['.github/workflows/upgrade-branch1-main.yml']).toBeDefined();
+    expect(outdir['.github/workflows/upgrade-branch2-main.yml']).toBeDefined();
+    expect(outdir['.github/workflows/upgrade-dev-deps-branch1-main.yml']).toBeDefined();
+    expect(outdir['.github/workflows/upgrade-dev-deps-branch2-main.yml']).toBeDefined();
+
+    // Verify the checkout refs in each workflow
+    expect(
+      YAML.parse(outdir['.github/workflows/upgrade-branch1-main.yml']).jobs.upgrade.steps
+        .find((step: any) => step.uses === 'actions/checkout@v4').with.ref,
+    ).toBe('branch1/main');
+
+    expect(
+      YAML.parse(outdir['.github/workflows/upgrade-branch2-main.yml']).jobs.upgrade.steps
+        .find((step: any) => step.uses === 'actions/checkout@v4').with.ref,
+    ).toBe('branch2/main');
+
+    expect(
+      YAML.parse(outdir['.github/workflows/upgrade-dev-deps-branch1-main.yml']).jobs.upgrade.steps
+        .find((step: any) => step.uses === 'actions/checkout@v4').with.ref,
+    ).toBe('branch1/main');
+
+    expect(
+      YAML.parse(outdir['.github/workflows/upgrade-dev-deps-branch2-main.yml']).jobs.upgrade.steps
+        .find((step: any) => step.uses === 'actions/checkout@v4').with.ref,
+    ).toBe('branch2/main');
+  });
 });
 
 describe('CdklabsTypeScriptProject', () => {