feat: Implemented changelog display in readme.txt

Author: seebeen

README.md

@@ -33,6 +33,7 @@ The plugin can be configured in the [**semantic-release** configuration file](ht
       "slug" : "my-plugin",
       "withAssets": true,
       "withReadme": true,
+      "withChangelog": true,
       "withVersionFile": true,
     }]
   ]
@@ -43,6 +44,7 @@ With this example, for each release, the plugin will:
   * Verify that the plugin is valid
   * Create a zip file for the plugin (/tmp/wp-release/my-plugin.zip)
   * Create a zip file for the assets (/tmp/wp-release/assets.zip)
+  * Write the release notes to the readme file (/tmp/wp-release/readme.txt)
   * Copy the readme.txt file (/tmp/wp-release/readme.txt)
   * Create a version file (/tmp/wp-release/version.txt)
 
@@ -59,6 +61,7 @@ Plugin uses no environment variables, but has a lot of configuration options
 | `path`            | The path of root folder that contains plugin or theme     | `./`                                                                  |
 | `withAssets`      | Does the package have assets (screenshots, banners, logo) | `false`                                                               |
 | `withReadme`      | Does the package have a readme.txt file                   | `false`                                                               |
+| `withChangelog`   | Are we writing the release notes to the readme file       | `false`                                                               |
 | `withVersionFile` | Do we need to create a file with the next release version | `true`                                                                |
 | `releasePath`     | Base path for all of the release files                    | `/tmp/wp-release`                                                     |
 | `versionFiles`    | Array of additional files containing the package version. | `[]`                                                                  |

lib/classes/plugin-config.class.ts

@@ -4,6 +4,7 @@ import {
   IsNotEmpty,
   IsOptional,
   IsString,
+  ValidateIf,
 } from 'class-validator';
 
 export class PluginConfig {
@@ -30,6 +31,14 @@ export class PluginConfig {
   @IsOptional()
   withReadme? = false;
 
+  /**
+   * Are we generating a changelog?
+   */
+  @IsBoolean()
+  @IsOptional()
+  @ValidateIf((o: PluginConfig) => o?.withReadme === true)
+  withChangelog? = false;
+
   /**
    * Do we output the version in a file?
    */

lib/prepare.ts

@@ -9,6 +9,7 @@ import { PrepareContext } from 'semantic-release';
 import { replaceVersions } from './utils/replace-versions.js';
 import { copyFiles } from './utils/copy-files.js';
 import { copyAssets } from './utils/copy-assets.js';
+import { prepareChangelog } from './utils/prepare-changelog.js';
 
 function getReadmePath(workDir: string): string | undefined {
   return ['.wordpress-org/readme.txt', 'readme.txt'].reduce(
@@ -41,6 +42,15 @@ export async function prepare(
 
   const readmePath = config.withReadme ? getReadmePath(workDir) : undefined;
 
+  if (readmePath && config.withChangelog) {
+    errors.push(
+      ...(await prepareChangelog(
+        path.resolve(workDir, readmePath),
+        context.nextRelease.notes,
+      )),
+    );
+  }
+
   readmePath && files.push(readmePath);
 
   errors.push(

lib/utils/prepare-changelog.ts

@@ -0,0 +1,55 @@
+import fs from 'fs-extra';
+import { marked } from 'marked';
+import SemanticReleaseError from '@semantic-release/error';
+import getError from './get-error.js';
+
+function stripLink(text: string): string {
+  return text.replace(/\[([^\]]+)]\([^)]+\)/g, '$1');
+}
+function stripEmoji(text: string): string {
+  return text.replace(/:\w+:/g, '').trim();
+}
+
+function stripCommitHash(text: string): string {
+  return text.replace(/\(.+\)$/, '').trim();
+}
+
+export async function prepareChangelog(
+  readmePath: string,
+  notes: string,
+): Promise<any> {
+  const errors: SemanticReleaseError[] = [];
+  const renderer = new marked.Renderer();
+
+  renderer.link = ({ text }) => text;
+  renderer.heading = ({ text, depth }) => {
+    if (depth === 2) {
+      return `= ${stripLink(text)} =\n\n`;
+    }
+
+    if (depth === 3) {
+      return `**${stripEmoji(text)}**\n\n`;
+    }
+
+    return `\n${text}\n\n`;
+  };
+  renderer.list = ({ items }) =>
+    `${items.map((item) => renderer.listitem(item)).join('')}\n`;
+  renderer.listitem = ({ text }) => `* ${stripCommitHash(stripLink(text))}\n`;
+
+  const output = (await marked(notes, { renderer }))
+    .replace(/\n{3,}/g, '\n\n')
+    .trim();
+
+  const readmeText = fs
+    .readFileSync(readmePath, 'utf-8')
+    .replace('== Changelog ==', `== Changelog ==\n\n${output}`);
+
+  try {
+    fs.writeFileSync(readmePath, readmeText);
+  } catch (err) {
+    errors.push(getError('EFILECOPY', readmePath));
+  }
+
+  return errors;
+}