https://github.com/zachspar/semantic-release-gha-output

A semantic-release plugin to output values from a GitHub Action.
https://github.com/zachspar/semantic-release-gha-output

github-actions javascript nodejs npm semantic-release semantic-release-plugin

Last synced: 5 months ago
JSON representation

A semantic-release plugin to output values from a GitHub Action.

• Host: GitHub
• URL: https://github.com/zachspar/semantic-release-gha-output
• Owner: zachspar
• License: mit
• Created: 2024-06-12T18:58:12.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-11-19T04:20:50.000Z (7 months ago)
• Last Synced: 2025-12-15T15:14:59.318Z (6 months ago)
• Topics: github-actions, javascript, nodejs, npm, semantic-release, semantic-release-plugin
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/semantic-release-gha-output
• Size: 709 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# semantic-release-gha-output

[![npm](https://img.shields.io/npm/v/semantic-release-gha-output.svg)](https://www.npmjs.com/package/semantic-release-gha-output)

A semantic-release plugin to output values from a GitHub Action.

| Step               | Description                                                                                  |

| ------------------ | -------------------------------------------------------------------------------------------- |

| `verifyConditions` | Sets GitHub Action output variable `published` to false                                     |

| `verifyRelease`    | Sets GitHub Action output variables `tag` & `version`                                        |

| `success`          | Sets GitHub Action output variable `published` to true                                      |

## Install

```bash

$ npm install semantic-release-gha-output

```

## Outputs

| Output             | Description                                                                                  |

| ------------------ | -------------------------------------------------------------------------------------------- |

| `tag`              | Next release git tag.                                                                        |

| `version`          | Next release version.                                                                        |

| `published`        | Boolean string to indicate whether a new release was published.                              |

## Usage

The plugin can be configured in the [**semantic-release** configuration file](https://github.com/semantic-release/semantic-release/blob/master/docs/usage/configuration.md#configuration) or via CLI:

```json

{

  "plugins": [

    "@semantic-release/commit-analyzer",

    "@semantic-release/release-notes-generator",

    "@semantic-release/github",

    "semantic-release-gha-output"

  ]

}

```