fix: corrupt changelog for prefixed releases (projen#1661)

When multiple version lines exist for a project, we use a [`releaseTagPrefix`](https://github.com/cdk8s-team/cdk8s-plus/blob/k8s-22/main/.projenrc.js#L50) property to distinguish between them. The problem was that this prefix wasn't being considered when generating the changelog, resulting in it simply accumulating commits, instead of doing proper diffs. > See https://github.com/cdk8s-team/cdk8s-plus/releases This PR fixes the issue by passing the `releaseTagPrefix` configuration down to `standard-version`, which generates the changelog. --- By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
FitX · Mar 16, 2022 · 44bb912 · 44bb912
1 parent 0b4aced
commit 44bb912
Show file tree

Hide file tree

Showing 10 changed files with 56 additions and 3 deletions.
diff --git a/.projen/tasks.json b/.projen/tasks.json
diff --git a/docs/api/API.md b/docs/api/API.md
@@ -2840,6 +2840,7 @@ new Version(project: Project, options: VersionOptions)
 * **options** (<code>[VersionOptions](#projen-versionoptions)</code>)  *No description*
   * **artifactsDirectory** (<code>string</code>)  The name of the directory into which `changelog.md` and `version.txt` files are emitted. 
   * **versionInputFile** (<code>string</code>)  A name of a .json file to set the `version` field in after a bump. 
+  * **tagPrefix** (<code>string</code>)  The tag prefix corresponding to this version. __*Optional*__
   * **versionrcOptions** (<code>Map<string, any></code>)  Custom configuration for versionrc file used by standard-release. __*Optional*__
 
 
@@ -11481,6 +11482,7 @@ Name | Type | Description
 -----|------|-------------
 **artifactsDirectory**🔹 | <code>string</code> | The name of the directory into which `changelog.md` and `version.txt` files are emitted.
 **versionInputFile**🔹 | <code>string</code> | A name of a .json file to set the `version` field in after a bump.
+**tagPrefix**?🔹 | <code>string</code> | The tag prefix corresponding to this version.<br/>__*Optional*__
 **versionrcOptions**?🔹 | <code>Map<string, any></code> | Custom configuration for versionrc file used by standard-release.<br/>__*Optional*__
 
 

diff --git a/src/release/bump-version.ts b/src/release/bump-version.ts
@@ -131,6 +131,9 @@ export async function bump(cwd: string, options: BumpOptions) {
   if (isFirstRelease) {
     cmd.push("--first-release");
   }
+  if (prefix) {
+    cmd.push(`--tag-prefix ${prefix}v`);
+  }
 
   exec(cmd.join(" "), { cwd });
 

diff --git a/src/release/release.ts b/src/release/release.ts
@@ -292,6 +292,7 @@ export class Release extends Component {
       versionInputFile: this.versionFile,
       artifactsDirectory: this.artifactsDirectory,
       versionrcOptions: options.versionrcOptions,
+      tagPrefix: options.releaseTagPrefix,
     });
 
     this.publisher = new Publisher(project, {

diff --git a/src/version.ts b/src/version.ts
@@ -24,6 +24,11 @@ export interface VersionOptions {
    * Custom configuration for versionrc file used by standard-release
    */
   readonly versionrcOptions?: Record<string, any>;
+
+  /**
+   * The tag prefix corresponding to this version.
+   */
+  readonly tagPrefix?: string;
 }
 
 export class Version extends Component {
@@ -80,6 +85,7 @@ export class Version extends Component {
       CHANGELOG: changelogFile,
       BUMPFILE: bumpFile,
       RELEASETAG: releaseTagFile,
+      RELEASE_TAG_PREFIX: options.tagPrefix ?? "",
       // doesn't work if custom configuration is long
       VERSIONRCOPTIONS: JSON.stringify(options.versionrcOptions),
     };

diff --git a/test/__snapshots__/integ.test.ts.snap b/test/__snapshots__/integ.test.ts.snap
diff --git a/test/release/__snapshots__/release.test.ts.snap b/test/release/__snapshots__/release.test.ts.snap
diff --git a/test/release/bump.test.ts b/test/release/bump.test.ts
@@ -81,7 +81,7 @@ test("select latest, with prefix", async () => {
     commits: [
       { message: "first version", tag: "prefix/v1.1.0" },
       { message: "unrelated version", tag: "v2.0.0" },
-      { message: "second version", tag: "prefix/v1.2.0" },
+      { message: "feat: feature 1", tag: "prefix/v1.2.0" },
       { message: "fix: bug" },
       { message: "fix: another bug" },
     ],
@@ -91,6 +91,7 @@ test("select latest, with prefix", async () => {
   expect(result.changelog.includes("Bug Fixes")).toBeTruthy();
   expect(result.changelog.includes("another bug")).toBeTruthy();
   expect(result.changelog.includes("bug")).toBeTruthy();
+  expect(result.changelog.includes("feature 1")).toBeFalsy();
   expect(result.bumpfile).toStrictEqual("1.2.1");
   expect(result.tag).toStrictEqual("prefix/v1.2.1");
 });

diff --git a/test/web/__snapshots__/nextjs-project.test.ts.snap b/test/web/__snapshots__/nextjs-project.test.ts.snap
diff --git a/test/web/__snapshots__/react-project.test.ts.snap b/test/web/__snapshots__/react-project.test.ts.snap