test: add test to validate changelogs for releases

Add a new test to check that the changelog files have been correctly updated for releases. PR-URL: #45325 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Rafael Gonzaga <[email protected]>

Author: richardlau

test/parallel/test-release-changelog.js

@@ -0,0 +1,93 @@
+'use strict';
+
+// This test checks that the changelogs contain an entry for releases.
+
+constcommon=require('../common');
+constassert=require('assert');
+constfs=require('fs');
+constpath=require('path');
+
+constgetDefine=(text,name)=>{
+constregexp=newRegExp(`#define\\s+${name}\\s+(.*)`);
+constmatch=regexp.exec(text);
+assert.notStrictEqual(match,null);
+returnmatch[1];
+};
+
+constsrcRoot=path.join(__dirname,'..','..');
+constmainChangelogFile=path.join(srcRoot,'CHANGELOG.md');
+constversionFile=path.join(srcRoot,'src','node_version.h');
+constversionText=fs.readFileSync(versionFile,{encoding: 'utf8'});
+constrelease=getDefine(versionText,'NODE_VERSION_IS_RELEASE')!=='0';
+
+if(!release){
+common.skip('release bit is not set');
+}
+
+constmajor=getDefine(versionText,'NODE_MAJOR_VERSION');
+constminor=getDefine(versionText,'NODE_MINOR_VERSION');
+constpatch=getDefine(versionText,'NODE_PATCH_VERSION');
+constversionForRegex=`${major}\\.${minor}\\.${patch}`;
+
+constlts=getDefine(versionText,'NODE_VERSION_IS_LTS')!=='0';
+constcodename=getDefine(versionText,'NODE_VERSION_LTS_CODENAME')
+.slice(1,-1);
+// If the LTS bit is set there should be a codename.
+if(lts){
+assert.notStrictEqual(codename,'');
+}
+
+constchangelogPath=`doc/changelogs/CHANGELOG_V${major}.md`;
+// Check CHANGELOG_V*.md
+{
+constchangelog=fs.readFileSync(path.join(srcRoot,changelogPath),
+{encoding: 'utf8'});
+// Check title matches major version.
+assert.match(changelog,newRegExp(`# Node\\.js ${major} ChangeLog`));
+// Check table header
+lettableHeader;
+if(lts){
+tableHeader=newRegExp(`<th>LTS '${codename}'</th>`);
+}else{
+tableHeader=/<th>Current<\/th>/;
+}
+assert.match(changelog,tableHeader);
+// Check table contains link to this release.
+assert.match(changelog,newRegExp(`<a href="#${versionForRegex}">${versionForRegex}</a>`));
+// Check anchor for this release.
+assert.match(changelog,newRegExp(`<a id="${versionForRegex}"></a>`));
+// Check title for changelog entry.
+lettitle;
+if(lts){
+title=newRegExp(`## \\d{4}-\\d{2}-\\d{2}, Version ${versionForRegex} '${codename}' \\(LTS\\), @\\S+`);
+}else{
+title=newRegExp(`## \\d{4}-\\d{2}-\\d{2}, Version ${versionForRegex} \\(Current\\), @\\S+`);
+}
+assert.match(changelog,title);
+}
+
+// Main CHANGELOG.md checks
+{
+constmainChangelog=fs.readFileSync(mainChangelogFile,
+{encoding: 'utf8'});
+// Check for the link to the appropriate CHANGELOG_V*.md file.
+letlinkToChangelog;
+if(lts){
+linkToChangelog=newRegExp(`\\[Node\\.js ${major}\\]\\(${changelogPath}\\) \\*\\*Long Term Support\\*\\*`);
+}else{
+linkToChangelog=newRegExp(`\\[Node\\.js ${major}\\]\\(${changelogPath}\\) \\*\\*Current\\*\\*`);
+}
+assert.match(mainChangelog,linkToChangelog);
+// Check table header.
+lettableHeader;
+if(lts){
+tableHeader=newRegExp(`<th title="LTS Until \\d{4}-\\d{2}"><a href="${changelogPath}">${major}</a><sup>LTS</sup></th>`);
+}else{
+tableHeader=newRegExp(`<th title="Current"><a href="${changelogPath}">${major}</a> \\(Current\\)</th>`);
+}
+assert.match(mainChangelog,tableHeader);
+// Check the table contains a link to the release in the appropriate
+// CHANGELOG_V*.md file.
+constlinkToVersion=newRegExp(`<b><a href="${changelogPath}#${versionForRegex}">${versionForRegex}</a></b><br/>`);
+assert.match(mainChangelog,linkToVersion);
+}