https://github.com/webdeveric/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.
https://github.com/webdeveric/semantic-release-lifecycles

semantic-release semantic-release-plugin

Last synced: 8 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/webdeveric/semantic-release-lifecycles
• Owner: webdeveric
• License: mit
• Created: 2024-08-11T15:11:42.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-12-08T16:51:43.000Z (5 months ago)
• Last Synced: 2025-05-03T01:21:28.211Z (9 days ago)
• Topics: semantic-release, semantic-release-plugin
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/semantic-release-lifecycles
• Size: 602 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# `semantic-release-lifecycles`

[![Node.js CI](https://github.com/webdeveric/semantic-release-lifecycles/actions/workflows/node.js.yml/badge.svg)](https://github.com/webdeveric/semantic-release-lifecycles/actions/workflows/node.js.yml)

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

## Install

```sh

pnpm add semantic-release-lifecycles -D

```

## Usage

Add this plugin to your `release.config.mjs`.

```js

/**

 * @type {Partial}

 */

export default {

  branches: ['main'],

  plugins: ['semantic-release-lifecycles'],

};

```

### Options

All options are optional.

```js

/**

 * @type {Partial}

 */

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',

      },

    ],

  ],

};

```