Merge pull request #1160 from ckeditor/ck/18670

Added validation for a username provided in the community contributors section.

Author: psmyrek

.changelog/20250618122716_ck_18670.md

@@ -0,0 +1,43 @@
+---
+# Required: Type of change.
+# Allowed values:
+# - Feature
+# - Fix
+# - Other
+# - Major breaking change
+# - Minor breaking change
+#
+# For guidance on breaking changes, see:
+# https://ckeditor.com/docs/ckeditor5/latest/updating/versioning-policy.html#major-and-minor-breaking-changes
+type: Fix
+
+# Optional: Affected package(s), using short names.
+# Can be skipped when processing a non-mono-repository.
+# Example: ckeditor5-core
+scope:
+  - ckeditor5-dev-changelog
+
+# Optional: Issues this change closes.
+# Format:
+# - {issue-number}
+# - {repo-owner}/{repo-name}#{issue-number}
+# - Full GitHub URL
+closes:
+  - ckeditor/ckeditor5#18670
+
+# Optional: Related issues.
+# Format:
+# - {issue-number}
+# - {repo-owner}/{repo-name}#{issue-number}
+# - Full GitHub URL
+see:
+  -
+
+# Optional: Community contributors.
+# Format:
+# - {github-username}
+communityCredits:
+  -
+---
+
+Added validation for a username provided in the community contributors section.

packages/ckeditor5-dev-changelog/src/utils/constants.ts

@@ -45,6 +45,8 @@ export const ISSUE_PATTERN = /^\d+$/;
 export const ISSUE_URL_PATTERN =
 	/^(?<base>https:\/\/github\.com)\/(?<owner>[a-z0-9.-]+)\/(?<repository>[a-z0-9.-]+)\/issues\/(?<number>\d+)$/;
 
+export const NICK_NAME_PATTERN = /^@[a-z0-9-_]+$/i;
+
 export const TYPES = [
 	{ name: 'Feature' },
 	{ name: 'Other' },

packages/ckeditor5-dev-changelog/src/utils/validateentry.ts

@@ -4,7 +4,7 @@
  */
 
 import type { ParsedFile } from '../types.js';
-import { ISSUE_PATTERN, ISSUE_SLUG_PATTERN, ISSUE_URL_PATTERN, TYPES } from './constants.js';
+import { ISSUE_PATTERN, ISSUE_SLUG_PATTERN, ISSUE_URL_PATTERN, NICK_NAME_PATTERN, TYPES } from './constants.js';
 
 /**
  * Validates a changelog entry against expected types, scopes, and issue references.
@@ -100,6 +100,18 @@ export function validateEntry( entry: ParsedFile, packagesNames: Array<string>,
 
 	data.closes = closesValidated;
 
+	const communityCreditsValidated = [];
+
+	for ( const nickName of data.communityCredits ) {
+		if ( !nickName.match( NICK_NAME_PATTERN ) ) {
+			validations.push( `Community username "${ nickName }" is not valid GitHub username.` );
+		} else {
+			communityCreditsValidated.push( nickName );
+		}
+	}
+
+	data.communityCredits = communityCreditsValidated;
+
 	const validatedEntry = {
 		...entry,
 		data: {

packages/ckeditor5-dev-changelog/tests/utils/validateentry.ts

@@ -12,6 +12,7 @@ vi.mock( '../../src/utils/constants.js', () => {
 		ISSUE_PATTERN: /^\d+$/,
 		ISSUE_SLUG_PATTERN: /^(?<owner>[a-z0-9.-]+)\/(?<repository>[a-z0-9.-]+)#(?<number>\d+)$/,
 		ISSUE_URL_PATTERN: /^(?<base>https:\/\/github\.com)\/(?<owner>[a-z0-9.-]+)\/(?<repository>[a-z0-9.-]+)\/issues\/(?<number>\d+)$/,
+		NICK_NAME_PATTERN: /^@[a-z0-9-_]+$/i,
 		TYPES: [
 			{ name: 'Feature' },
 			{ name: 'Other' },
@@ -317,30 +318,71 @@ describe( 'validateEntry()', () => {
 		} );
 	} );
 
+	describe( 'communityCredits validation', () => {
+		it( 'should add validation message but remain valid when community username is not valid GitHub username', () => {
+			const entry: ParsedFile = createEntry( { type: 'Feature', communityCredits: [ '@i n v a l i d n a m e' ] } );
+
+			const { isValid, validatedEntry } = validateEntry( entry, packageNames, false );
+
+			expect( isValid ).toBeTruthy();
+			expect( validatedEntry.data.validations ).toContain(
+				'Community username "@i n v a l i d n a m e" is not valid GitHub username.'
+			);
+			expect( validatedEntry.data.communityCredits ).toEqual( [] );
+		} );
+
+		it( 'should return valid when community username is valid GitHub username', () => {
+			const entry: ParsedFile = createEntry( { type: 'Feature', communityCredits: [ '@exampleName123' ] } );
+
+			const { isValid, validatedEntry } = validateEntry( entry, packageNames, false );
+
+			expect( isValid ).toBeTruthy();
+			expect( validatedEntry.data.communityCredits ).toEqual( [ '@exampleName123' ] );
+		} );
+
+		it( 'should filter out invalid community usernames while keeping valid ones', () => {
+			const entry: ParsedFile = createEntry( {
+				type: 'Feature',
+				communityCredits: [ '@i n v a l i d n a m e', '@exampleName123' ]
+			} );
+
+			const { isValid, validatedEntry } = validateEntry( entry, packageNames, false );
+
+			expect( isValid ).toBeTruthy();
+			expect( validatedEntry.data.validations ).toContain(
+				'Community username "@i n v a l i d n a m e" is not valid GitHub username.'
+			);
+			expect( validatedEntry.data.communityCredits ).toEqual( [ '@exampleName123' ] );
+		} );
+	} );
+
 	describe( 'multiple validations', () => {
 		it( 'should collect multiple validation errors but only mark as invalid for critical errors', () => {
 			const entry: ParsedFile = createEntry( {
 				type: 'Unknown',
 				scope: [ 'unknown-package' ],
 				see: [ 'invalid-reference' ],
-				closes: [ 'invalid-reference' ]
+				closes: [ 'invalid-reference' ],
+				communityCredits: [ '@i n v a l i d n a m e' ]
 			} );
 
 			const { isValid, validatedEntry } = validateEntry( entry, packageNames, false );
 
 			expect( isValid ).toBeFalsy();
-			expect( validatedEntry.data.validations?.length ).toBe( 4 );
+			expect( validatedEntry.data.validations?.length ).toBe( 5 );
 			expect( validatedEntry.data.scope ).toEqual( [] );
 			expect( validatedEntry.data.see ).toEqual( [] );
 			expect( validatedEntry.data.closes ).toEqual( [] );
+			expect( validatedEntry.data.communityCredits ).toEqual( [] );
 		} );
 
 		it( 'should return valid for a completely valid entry', () => {
 			const entry: ParsedFile = createEntry( {
 				type: 'Feature',
 				scope: [ 'ckeditor5-engine' ],
 				see: [ '1234' ],
-				closes: [ 'ckeditor/ckeditor5#5678' ]
+				closes: [ 'ckeditor/ckeditor5#5678' ],
+				communityCredits: [ '@exampleName123' ]
 			} );
 
 			const { isValid, validatedEntry } = validateEntry( entry, packageNames, false );