semantic-release-lifecycles

This plugin for semantic-release will log lifecycle data to JSON files so you can see what data is available at each step.

Install

pnpm add semantic-release-lifecycles -D

Usage

Add this plugin to your release.config.mjs.

/**
 * @type {Partial<import('semantic-release').GlobalConfig>}
 */
export default {
  branches: ['main'],
  plugins: ['semantic-release-lifecycles'],
};

Options

All options are optional.

/**
 * @type {Partial<import('semantic-release').GlobalConfig>}
 */
export default {
  branches: ['main'],
  plugins: [
    [
      'semantic-release-lifecycles',
      {
        // Pass in lifecycle names you want to enable. Look at `types.ts` for full list.
        enabled: ['success', 'fail'],
        // Customize where each lifecycle file is written.
        // The naming convention is `${LifecycleName}OutputFile`.
        successOutputFile: 'success.json',
      },
    ],
  ],
};