1.0.0 • Published 1 year ago

semantic-release-pulsar v1.0.0

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

semantic-release-pulsar

semantic-release plugin to publish Pulsar packages.

Build Status npm latest version

StepDescription
verifyConditionsVerify the presence of the PULSAR_ACCESS_TOKEN environment variable and the pulsar CLI.
prepareUpdate the package.json version with npm version.
publishPublish the Pulsar package.

Install

$ npm install semantic-release-pulsar @semantic-release/git -D

Note: pulsar require to have the version in package.json pushed to the repository so the @semantic-release/git plugin is required.

Usage

The plugin can be configured in the semantic-release configuration file:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    "@semantic-release/github",
    "semantic-release-pulsar",
    "@semantic-release/git"
  ]
}

Configuration

Pulsar installation

The plugin uses the pulsar CLI which has to be installed in your CI environment and available in the PATH.

See the Pulsar Action documentation to install pulsar in your CI.

Atom authentication

The Pulsar authentication configuration is required and can be set via environment variables.

Visit your account page on web.pulsar-edit.dev to obtain your authentication token. The token has to be made available in your CI environment via the PULSAR_ACCESS_TOKEN environment variable.

Environment variables

VariableDescription
PULSAR_ACCESS_TOKENThe token used to authenticate with Pulsar registry.

Credits

This package is a fork of the original apm package.