@ckeditor/ckeditor5-dev-release-tools 39.2.1 → 39.4.0

package/lib/tasks/generatechangelogformonorepository.js

@@ -58,6 +58,9 @@ const noteInfo = `[ℹ️](${ VERSIONING_POLICY_URL }#major-and-minor-breaking-c
  *
  * @param {String|null} [options.nextVersion=null] Next version to use. If not provided, a user needs to provide via CLI.
  *
+ * @param {FormatDateCallback} [options.formatDate] A callback allowing defining a custom format of the date inserted into the changelog.
+ * If not specified, the default date matches the `YYYY-MM-DD` pattern.
+ *
  * @returns {Promise.<undefined|String>}
  */
 module.exports = async function generateChangelogForMonoRepository( options ) {
@@ -406,7 +409,8 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
 			previousTag: options.from ? options.from : 'v' + rootPkgJson.version,
 			isPatch: semver.diff( version, rootPkgJson.version ) === 'patch',
 			skipCommitsLink: Boolean( options.skipLinks ),
-			skipCompareLink: Boolean( options.skipLinks )
+			skipCompareLink: Boolean( options.skipLinks ),
+			date: options.formatDate ? options.formatDate( new Date() ) : changelogUtils.getFormattedDate()
 		};
 
 		const writerOptions = getWriterOptions( {
@@ -748,3 +752,11 @@ module.exports = async function generateChangelogForMonoRepository( options ) {
  * @param {String} [releaseBranch] A name of the branch that should be used for releasing packages. If not specified, the branch
  * used for the main repository will be used.
  */
+
+/**
+ * @callback FormatDateCallback
+ *
+ * @param {Date} now The current date.
+ *
+ * @returns {String} The formatted date inserted into the changelog.
+ */

package/lib/tasks/generatechangelogforsinglepackage.js

@@ -35,6 +35,9 @@ const SKIP_GENERATE_CHANGELOG = 'Typed "skip" as a new version. Aborting.';
  *
  * @param {String} [options.releaseBranch='master'] A name of the branch that should be used for releasing packages.
  *
+ * @param {FormatDateCallback} [options.formatDate] A callback allowing defining a custom format of the date inserted into the changelog.
+ * If not specified, the default date matches the `YYYY-MM-DD` pattern.
+ *
  * @returns {Promise}
  */
 module.exports = async function generateChangelogForSinglePackage( options = {} ) {
@@ -102,7 +105,8 @@ module.exports = async function generateChangelogForSinglePackage( options = {}
 				isPatch: semver.diff( version, pkgJson.version ) === 'patch',
 				isInternalRelease,
 				skipCommitsLink: Boolean( options.skipLinks ),
-				skipCompareLink: Boolean( options.skipLinks )
+				skipCompareLink: Boolean( options.skipLinks ),
+				date: options.formatDate ? options.formatDate( new Date() ) : changelogUtils.getFormattedDate()
 			};
 
 			const writerOptions = getWriterOptions( {
@@ -192,3 +196,11 @@ module.exports = async function generateChangelogForSinglePackage( options = {}
 		log[ method ]( `${ startWithNewLine ? '\n' : '' }${ ' '.repeat( indentLevel * cli.INDENT_SIZE ) }` + message );
 	}
 };
+
+/**
+ * @callback FormatDateCallback
+ *
+ * @param {Date} now The current date.
+ *
+ * @returns {String} The formatted date inserted into the changelog.
+ */

package/lib/utils/changelog.js

@@ -7,6 +7,7 @@
 
 const fs = require( 'fs' );
 const path = require( 'path' );
+const { format } = require( 'date-fns' );
 const { getRepositoryUrl } = require( './transformcommitutils' );
 
 const utils = {
@@ -95,6 +96,13 @@ const utils = {
 		const truncatedChangelog = utils.changelogHeader + truncatedEntries.join( '\n' ).trim() + changelogFooter;
 
 		utils.saveChangelog( truncatedChangelog, cwd );
+	},
+
+	/**
+	 * @returns {String}
+	 */
+	getFormattedDate() {
+		return format( new Date(), 'yyyy-MM-dd' );
 	}
 };
 

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@ckeditor/ckeditor5-dev-release-tools",
-  "version": "39.2.1",
+  "version": "39.4.0",
   "description": "Tools used for releasing CKEditor 5 and related packages.",
   "keywords": [],
   "main": "lib/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-dev-utils": "^39.2.1",
+    "@ckeditor/ckeditor5-dev-utils": "^39.4.0",
     "@octokit/rest": "^19.0.0",
     "chalk": "^4.0.0",
     "cli-table": "^0.3.1",
@@ -15,6 +15,7 @@
     "conventional-changelog-writer": "^6.0.0",
     "conventional-commits-filter": "^3.0.0",
     "conventional-commits-parser": "^4.0.0",
+    "date-fns": "^2.30.0",
     "diff": "^5.0.0",
     "fs-extra": "^9.1.0",
     "git-raw-commits": "^3.0.0",