fix(monorepo): warning "The distTag option is deprecated. Use the n…

…pmDistTag option instead." (#798)
cdklabs · Feb 19, 2025 · 34d4703 · 34d4703
1 parent a19d4a7
commit 34d4703
Show file tree

Hide file tree

Showing 3 changed files with 44 additions and 7 deletions.
diff --git a/src/yarn/monorepo-release.ts b/src/yarn/monorepo-release.ts
@@ -28,6 +28,7 @@ export class MonorepoRelease extends Component {
     readonly release: {
       readonly workspace: TypeScriptWorkspace;
       readonly publisher: projenRelease.Publisher;
+      readonly options: Partial<projenRelease.BranchOptions>;
     };
   }>();
 
@@ -72,6 +73,17 @@ export class MonorepoRelease extends Component {
         release: {
           workspace: workspaceRelease.workspace,
           publisher: workspaceRelease.publisher,
+          options: {
+            // enforced options
+            workflowName: this.options.releaseWorkflowName,
+            tagPrefix: `${project.name}@`,
+
+            // options that may be override locally
+            majorVersion: options.versionBranchOptions.majorVersion ?? this.options.majorVersion,
+            minMajorVersion: options.versionBranchOptions.minMajorVersion ?? this.options.minMajorVersion,
+            prerelease: options.versionBranchOptions.prerelease ?? this.options.prerelease,
+            npmDistTag: options.npmDistTag ?? this.options.npmDistTag,
+          },
         },
       });
     }
@@ -116,12 +128,7 @@ export class MonorepoRelease extends Component {
 
   private renderPublishJobs() {
     for (const { release } of this.packagesToRelease) {
-      const packagePublishJobs = release.publisher._renderJobsForBranch(this.branchName, {
-        majorVersion: this.options.majorVersion,
-        minMajorVersion: this.options.minMajorVersion,
-        npmDistTag: this.options.npmDistTag,
-        prerelease: this.options.prerelease,
-      });
+      const packagePublishJobs = release.publisher._renderJobsForBranch(this.branchName, release.options);
 
       for (const job of Object.values(packagePublishJobs)) {
         // Find the 'download-artifact' job and replace the build artifact name with the unique per-project one

diff --git a/src/yarn/typescript-workspace-release.ts b/src/yarn/typescript-workspace-release.ts
@@ -62,7 +62,6 @@ export class WorkspaceRelease extends Component {
       // GitHub Releases comes for free with a `Release` component, NPM must be added explicitly
       if (options.publishToNpm ?? true) {
         this.publisher.publishToNpm({
-          distTag: options.npmDistTag,
           registry: project.package.npmRegistry,
           npmTokenSecret: project.package.npmTokenSecret,
         });

diff --git a/test/cdklabs-monorepo.test.ts b/test/cdklabs-monorepo.test.ts
@@ -168,6 +168,37 @@ describe('CdkLabsMonorepo', () => {
           })]),
         }));
     });
+
+    test('prerelease is respected for the right workspace package', () => {
+      new yarn.TypeScriptWorkspace({
+        parent,
+        name: '@cdklabs/one',
+        prerelease: 'rc',
+      });
+
+      new yarn.TypeScriptWorkspace({
+        parent,
+        name: '@cdklabs/two',
+      });
+
+      Testing.synth(parent);
+
+      expect(parent.github?.tryFindWorkflow('release')?.getJob('cdklabs-one_release_github'))
+        .toMatchObject(expect.objectContaining({
+          steps: expect.arrayContaining([expect.objectContaining({
+            name: 'Release',
+            run: expect.stringContaining('-p'),
+          })]),
+        }));
+
+      expect(parent.github?.tryFindWorkflow('release')?.getJob('cdklabs-two_release_github'))
+        .toMatchObject(expect.objectContaining({
+          steps: expect.arrayContaining([expect.objectContaining({
+            name: 'Release',
+            run: expect.not.stringContaining('-p'),
+          })]),
+        }));
+    });
   });
 
   describe('VSCode Workspace', () => {