# heroku-deploy

> A simple utility for deploying a .tar.gz to Heroku via the Heroku Platform API.

Latest version **0.1.0** (published 2015-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install heroku-deploy
pnpm add heroku-deploy
yarn add heroku-deploy
bun add heroku-deploy
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2015-09-21 |
| First published | 2015-09-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 1 |
| Maintainers | giannico |
| Keywords | tiny-lr, browser-sync, livereload |

## Links

- npm: https://www.npmjs.com/package/heroku-deploy
- Repository: https://github.com/giannico/heroku-deploy/heroku-deploy
- Homepage: http://github.com/giannico/heroku-deploy
- Issues: https://github.com/giannico/heroku-deploy/issues
- npm.io page: https://npm.io/package/heroku-deploy

## Dependencies (2)

- [request](https://npm.io/package/request.md) ^2.62.0
- [bluebird](https://npm.io/package/bluebird.md) ^2.10.0

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.1.0 (latest) — 2015-09-21

## README

# heroku-deploy

A simple utility for deploying a .tar.gz to Heroku via the Heroku Platform API.

https://devcenter.heroku.com/articles/build-and-release-using-the-api

## Usage

``` javascript
var herokuDeploy = require('heroku-deploy');

herokuDeploy(herokuApiKey, herokuAppName, packageJson.version, releaseFilename).
    then(function(response) {
        console.log('Build request successfully submitted.');
        log(response);
    }).
    catch(function(err) {
        console.log(err);
        throw new Error('A heroku deployment error has occurred.');
    });
```

## Signature

``` javascript
// herokuApiKey    - your heroku api key
// herokuAppName   - the name of the heroku app you're deploying to
// appVersion      - a version tag for your application
// releaseFileName - the absolute path to the .tar.gz file
// 
// returns a bluebird promise
```

---
_Source: https://npm.io/package/heroku-deploy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._