semantic-release-circleci-orb

    1.1.1 • Public • Published

    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, orbName option, and the circleci CLI.
    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",
          {
            "orbName": "react-native-community/circleci-orb",
            "orbPath": "orb.yml"
          }
        ]
      ]
    }

    Configuration

    Environment variables

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

    Options

    Options Description Default
    orbName Required. The name of the Orb in the format of organisation/orb. For example, react-native-community/circleci-orb. None. You need to set your own.
    commandName The name of the CircleCI command to run. circleci
    orbPath The path to the Orb YAML file. This needs to be a single (packed) YAML file. orb.yml

    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.

    Install

    npm i semantic-release-circleci-orb

    DownloadsWeekly Downloads

    888

    Version

    1.1.1

    License

    MIT

    Unpacked Size

    10.8 kB

    Total Files

    9

    Last publish

    Collaborators

    • mattoakes