JSPM

semantic-release-circleci-orb

0.1.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 69
  • Score
    100M100P100Q82268F
  • License MIT

semantic-release plugin to publish CircleCI Orbs

Package Exports

  • semantic-release-circleci-orb

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (semantic-release-circleci-orb) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

semantic-release-circleci-orb

semantic-release plugin to publish CircleCI Orbs.

npm latest version

Step Description
verifyConditions Verify the presence of the CIRCLECI_API_TOKEN environment variable and the circleci CLI.
prepare Update the package.json version with npm version.
publish Publish the CircleCI orb.

Install

$ npm install semantic-release-circleci-orb -D

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-circleci-orb"
  ]
}

Configuration

CircleCI CLI installation

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

CircleCI authentication

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

Visit your account page on CircleCI.com to obtain your API token. The token has to be made available in your CI environment via the CIRCLECI_API_TOKEN environment variable.

Environment variables

Variable Description
CIRCLECI_API_TOKEN The token used to authenticate with CircleCI account.