Merge pull request #651 from ckeditor/i/7495

Fix (env): Scoped breaking changes notes won't be duplicated in the changelog. Closes ckeditor/ckeditor5#7495.
ckeditor · Jun 29, 2020 · e4eefa6 · e4eefa6
2 parents cedc53f + 2d79afd
commit e4eefa6
Show file tree

Hide file tree

Showing 2 changed files with 30 additions and 4 deletions.
diff --git a/packages/ckeditor5-dev-env/lib/release-tools/utils/transformcommitfactory.js b/packages/ckeditor5-dev-env/lib/release-tools/utils/transformcommitfactory.js
@@ -110,7 +110,7 @@ module.exports = function transformCommitFactory( options = {} ) {
 						// For each footer line checks whether the line starts with note prefix.
 						// If so, this footer line should be removed.
 						const noteToRemove = commitsNotes.find( note => {
-							return footerLine == `${ note.title }: ${ note.text }`;
+							return footerLine.startsWith( note.title ) && footerLine.endsWith( note.text );
 						} );
 
 						// In order to avoid checking the same note, remove it.
@@ -121,7 +121,7 @@ module.exports = function transformCommitFactory( options = {} ) {
 						return !noteToRemove;
 					} )
 					.join( '\n' )
-					.trim();
+					.trim() || null;
 			}
 
 			// If `body` of the commit is empty but the `footer` isn't, let's swap those.
@@ -314,7 +314,7 @@ module.exports = function transformCommitFactory( options = {} ) {
 	 *
 	 * E.g.:
 	 *   - input: `Fix (engine): Fixed...
-	 *   - output: { rawType: 'Fix', scope: [ 'engine'] }
+	 *   - output: { rawType: 'Fix', scope: [ 'engine' ] }
 	 *
 	 * For commits with no scope, `null` will be returned instead of the array (as `scope`).
 	 *
@@ -348,7 +348,7 @@ module.exports = function transformCommitFactory( options = {} ) {
 	 *
 	 * E.g.:
 	 *   - input: `(engine): Removed...
-	 *   - output: { text: 'Removed...', scope: [ 'engine'] }
+	 *   - output: { text: 'Removed...', scope: [ 'engine' ] }
 	 *
 	 * For notes with no scope, `null` will be returned instead of the array (as `scope`).
 	 *

diff --git a/packages/ckeditor5-dev-env/tests/release-tools/utils/transformcommitfactory.js b/packages/ckeditor5-dev-env/tests/release-tools/utils/transformcommitfactory.js
@@ -400,6 +400,32 @@ describe( 'dev-env/release-tools/utils', () => {
 				expect( commit.notes ).to.deep.equal( notes );
 			} );
 
+			// See: https://github.com/ckeditor/ckeditor5/issues/7495.
+			it( 'removes duplicated scoped notes from the footer', () => {
+				const rawCommit = {
+					type: 'Other (table)',
+					subject: 'Extracted `TableMouse` plugin from `TableSelection` plugin. Closes #6757.',
+					merge: 'Merge pull request #7355 from ckeditor/i/6757',
+					header: 'Other (table): Extracted `TableMouse` plugin from `TableSelection` plugin. Closes #6757.',
+					body: null,
+					footer: 'MINOR BREAKING CHANGE (table): The `TableNavigation` plugin renamed to `TableKeyboard`.',
+					notes: [
+						{
+							title: 'MINOR BREAKING CHANGE',
+							text: '(table): The `TableNavigation` plugin renamed to `TableKeyboard`.'
+						}
+					],
+					references: [],
+					mentions: [],
+					revert: null,
+					hash: '4d2f5f9b9f298601b332f304da66333c52673cb8'
+				};
+
+				const commit = transformCommit( rawCommit );
+
+				expect( commit.footer ).to.equal( null );
+			} );
+
 			// See: https://github.com/ckeditor/ckeditor5/issues/7489.
 			describe( 'internal merge commits', () => {
 				const mergeCommitsToIgnore = [