semantic-release-wordpress-readme-generator

Generates a readme.txt for WordPress plugin releases.

Installation

With Yarn

yarn add -D @myparcel/semantic-release-wordpress-readme-generator

With PNPM

pnpm add -D @myparcel/semantic-release-wordpress-readme-generator

With NPM

npm install --save-dev @myparcel/semantic-release-wordpress-readme-generator

Usage

Add the following to your release.config.js, below the @semantic-release/changelog plugin:

const wordpressReadme = require('@myparcel/semantic-release-wordpress-readme-generator');

module.exports = {
  plugins: [
    // ...
    '@myparcel/semantic-release-wordpress-readme-generator',
  ],
};

Options

By default, this is the configuration that will be used. This defines which commits will be included in the readme, and the order in which the entries will be written.

Type	Prefix
feat	New:
fix	Fixed bug:
perf	Performance improvement:
revert	Reverted:

To customize this, pass an object to the plugin and override the types property:

const wordpressReadme = require('@myparcel/semantic-release-wordpress-readme-generator');

module.exports = {
  plugins: [
    // ...
    [
      '@myparcel/semantic-release-wordpress-readme-generator',
      {
        types: [
          {
            type: 'feat',
            prefix: 'Feature: ',
          },
          {
            type: 'fix',
            prefix: 'Fix: ',
          },
        ]
      }
    ],
  ],
};