semantic-release-heroku

plugin to publish a Heroku App using semantic-releases

Usage no npm install needed!

<script type="module">
  import semanticReleaseHeroku from 'https://cdn.skypack.dev/semantic-release-heroku';
</script>

README

semantic-release-heroku

semantic-release plugin. Provides the ability to publish Heroku apps.

Version Bundle size Downloads

CodeFactor SonarCloud Codacy Total alerts Language grade Scrutinizer

Dependencies Security Build Status Coverage Status

Commit activity FOSSA License

Table of Contents

Requirements

Platform Status

To use library you need to have node and npm installed in your machine:

  • node >=10
  • npm >=6

Package is continuously tested on darwin, linux, win32 platforms. All active and maintenance LTS node releases are supported.

This package is shipped as semantic-release plugin, so you need to have semantic-release installed and configured.

Installation

To install the library, run the following command:

  npm i --save-dev semantic-release-heroku

Usage

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

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

This is a minimal usage sample with a default configuration.

Configuration

if needed, the configuration can be extended:

{
  "plugins": [
    "@semantic-release/commit-analyzer",
    "@semantic-release/release-notes-generator",
    ["semantic-release-heroku", {
      "name": "funny-app",
      "npmVersion": false,
      "tarballDir": "./dist"
    }]
  ]
}

Config attribute description:

Option Required Type Description Default
name no string Heroku application name. name from package.json
npmVersion no boolean Whether to update package.json and package-lock with new version value false, package.json won't be touched
tarballDir no string Path to directory, where you can keep generated tarball. Tarball will be generated into os /tmp directory

Authentication

In order to publish stuff to Heroku, you should obtain the Heroku API token. The easiest way to achieve this is to open profile page and reveal the API key.

If you already have an API key, add it as an environment variable:

  HEROKU_API_KEY='<uuid>'

Contribute

Make the changes to the code and tests. Then commit to your branch. Be sure to follow the commit message conventions. Read Contributing Guidelines for details.