From d4c8b27374c64109b5a44bda5e5162c58c9ae990 Mon Sep 17 00:00:00 2001 From: FrozenPandaz Date: Fri, 15 Mar 2024 10:27:02 -0400 Subject: [PATCH] fix(release): fix default renderer resolution to be relative within the package --- .../release/config/config.spec.ts | 113 ++++++++++-------- .../src/command-line/release/config/config.ts | 11 +- .../command-line/release/utils/shared.spec.ts | 2 +- .../update-17-3-0/nx-release-path.ts | 1 - 4 files changed, 75 insertions(+), 52 deletions(-) diff --git a/packages/nx/src/command-line/release/config/config.spec.ts b/packages/nx/src/command-line/release/config/config.spec.ts index 29321e41d462a..1999b868375b6 100644 --- a/packages/nx/src/command-line/release/config/config.spec.ts +++ b/packages/nx/src/command-line/release/config/config.spec.ts @@ -1,7 +1,26 @@ import { ProjectFileMap, ProjectGraph } from '../../../config/project-graph'; import { TempFs } from '../../../internal-testing-utils/temp-fs'; import { createNxReleaseConfig } from './config'; +import { join } from 'path'; +expect.addSnapshotSerializer({ + serialize: (str: string) => { + // replace all instances of the workspace root with a placeholder to ensure consistency + return JSON.stringify( + str.replaceAll( + new RegExp(join(__dirname, '../../../..').replace(/\\/g, '\\\\'), 'g'), + '' + ) + ); + }, + test(val: string) { + return ( + val != null && + typeof val === 'string' && + val.includes(join(__dirname, '../../../..')) + ); + }, +}); describe('createNxReleaseConfig()', () => { let projectGraph: ProjectGraph; let projectFileMap: ProjectFileMap; @@ -132,7 +151,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -304,7 +323,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -479,7 +498,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -685,7 +704,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -875,7 +894,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -1074,7 +1093,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -1271,7 +1290,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -1453,7 +1472,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -1630,7 +1649,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -2003,7 +2022,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -2121,7 +2140,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-a", @@ -2304,7 +2323,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-a", @@ -2327,7 +2346,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-b", @@ -2507,7 +2526,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-a", @@ -2580,7 +2599,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -2762,7 +2781,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -2943,7 +2962,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -3120,7 +3139,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -3317,7 +3336,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -3492,7 +3511,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -3679,7 +3698,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -3797,7 +3816,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "nx", @@ -4047,7 +4066,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": false, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "workspaceChangelog": { "createRelease": false, @@ -4058,7 +4077,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -4176,7 +4195,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": false, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-a", @@ -4245,7 +4264,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "workspaceChangelog": { "createRelease": false, @@ -4256,7 +4275,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -4374,7 +4393,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-a", @@ -4444,7 +4463,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -4622,7 +4641,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -4798,7 +4817,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -4996,7 +5015,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -5191,7 +5210,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -5382,7 +5401,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -5574,7 +5593,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -5769,7 +5788,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -5981,7 +6000,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "workspaceChangelog": false, }, @@ -6100,7 +6119,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-a", @@ -6136,7 +6155,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "nx", @@ -6215,7 +6234,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "workspaceChangelog": { "createRelease": "github", @@ -6226,7 +6245,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -6344,7 +6363,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, "projects": [ "lib-a", @@ -6966,7 +6985,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -7150,7 +7169,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -7333,7 +7352,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -7524,7 +7543,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { @@ -7705,7 +7724,7 @@ describe('createNxReleaseConfig()', () => { "commitReferences": true, "versionTitleDate": true, }, - "renderer": "nx/release/changelog-renderer", + "renderer": "/release/changelog-renderer", }, }, "conventionalCommits": { diff --git a/packages/nx/src/command-line/release/config/config.ts b/packages/nx/src/command-line/release/config/config.ts index f0b10862019a9..bb62d5a682ef0 100644 --- a/packages/nx/src/command-line/release/config/config.ts +++ b/packages/nx/src/command-line/release/config/config.ts @@ -191,6 +191,11 @@ export async function createNxReleaseConfig( userGroups[0].projectsRelationship === 'independent') || (userConfig.projectsRelationship === 'independent' && !userGroups.some((g) => g.projectsRelationship === 'fixed')); + + const defaultRendererPath = join( + __dirname, + '../../../../release/changelog-renderer' + ); const WORKSPACE_DEFAULTS: Omit = { // By default all projects in all groups are released together projectsRelationship: workspaceProjectsRelationship, @@ -211,7 +216,7 @@ export async function createNxReleaseConfig( entryWhenNoChanges: 'This was a version bump only, there were no code changes.', file: '{workspaceRoot}/CHANGELOG.md', - renderer: 'nx/release/changelog-renderer', + renderer: defaultRendererPath, renderOptions: { authors: true, commitReferences: true, @@ -225,7 +230,7 @@ export async function createNxReleaseConfig( file: '{projectRoot}/CHANGELOG.md', entryWhenNoChanges: 'This was a version bump only for {projectName} to align it with other projects, there were no code changes.', - renderer: 'nx/release/changelog-renderer', + renderer: defaultRendererPath, renderOptions: { authors: true, commitReferences: true, @@ -259,7 +264,7 @@ export async function createNxReleaseConfig( entryWhenNoChanges: 'This was a version bump only for {projectName} to align it with other projects, there were no code changes.', file: '{projectRoot}/CHANGELOG.md', - renderer: 'nx/release/changelog-renderer', + renderer: defaultRendererPath, renderOptions: { authors: true, commitReferences: true, diff --git a/packages/nx/src/command-line/release/utils/shared.spec.ts b/packages/nx/src/command-line/release/utils/shared.spec.ts index cfd93a6c75361..49e215a435303 100644 --- a/packages/nx/src/command-line/release/utils/shared.spec.ts +++ b/packages/nx/src/command-line/release/utils/shared.spec.ts @@ -96,7 +96,7 @@ describe('shared', () => { entryWhenNoChanges: 'This was a version bump only for {projectName} to align it with other projects, there were no code changes.', file: '{projectRoot}/CHANGELOG.md', - renderer: 'nx/release/changelog-renderer', + renderer: 'custom-changelog-renderer', renderOptions: { authors: true }, }, releaseTagPattern: '{projectName}-{version}', diff --git a/packages/nx/src/migrations/update-17-3-0/nx-release-path.ts b/packages/nx/src/migrations/update-17-3-0/nx-release-path.ts index 12724070e7a19..90c417c721daf 100644 --- a/packages/nx/src/migrations/update-17-3-0/nx-release-path.ts +++ b/packages/nx/src/migrations/update-17-3-0/nx-release-path.ts @@ -4,7 +4,6 @@ import { getIgnoreObject } from '../../utils/ignore'; export default function nxReleasePath(tree: Tree) { visitNotIgnoredFiles(tree, '', (file) => { - console.log({ file }); const contents = tree.read(file).toString('utf-8'); if ( // the deep import usage should be replaced by the new location