@dotcom-tool-kit/heroku

v3.4.2

This plugin handles deploying apps to Heroku. It also manages Tool Kit hooks that are run during Heroku builds. For more information about how to use this package see README

Latest version published 17 days ago

License: ISC

NPM

GitHub

Package Health Score

70 / 100

security
Security review needed
popularity
Limited
maintenance
Healthy
community
Sustainable

Explore Similar Packages

heroku
84

Security

Security review needed

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
3.4.2	\|	07/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.4.1	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
3.3.15	\|	12/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.2.0	\|	04/2023		0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.9.0	\|	04/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

ISC

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (470)

GitHub Stars: 13
Forks: 2
Contributors: 30

Direct Usage Popularity

The npm package @dotcom-tool-kit/heroku receives a total of 470 downloads a week. As such, we scored @dotcom-tool-kit/heroku popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package @dotcom-tool-kit/heroku, we found that it has been starred 13 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: No
Code of Conduct: No
Contributors: 30
Funding: No

With more than 10 contributors for the @dotcom-tool-kit/heroku repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like @dotcom-tool-kit/heroku is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 2
Open PR: 12
Last Release: 17 days ago
Last Commit: 2 days ago

Further analysis of the maintenance status of @dotcom-tool-kit/heroku based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @dotcom-tool-kit/heroku demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: 16

Age: 3 years
Dependencies: 15 Direct
Versions: 160
Install Size: 51 kB
Dist-tags: 2
# of Files: 63
Maintainers: 3
TS Typings: No

@dotcom-tool-kit/heroku has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

@dotcom-tool-kit/heroku

This plugin handles deploying apps to Heroku. It also manages Tool Kit hooks that are run during Heroku builds.

This plugin will be installed as a dependency of the frontend-app and backend-heroku-app plugins so you do not need to install it separately if you are using either of those plugins.

Installation

Install @dotcom-tool-kit/heroku as a devDependency in your app:

npm install --save-dev @dotcom-tool-kit/heroku

Add the plugin to your Tool Kit configuration:

plugins:
  - '@dotcom-tool-kit/heroku'

And install this plugin's hooks:

npx dotcom-tool-kit --install

This plugin cannot currently automatically install itself to heroku configuration, so it will exit, and explain what you need to include in the config.

Options

Key	Description	Default value
`pipeline`	(required) the pipeline name for your application as it's defined in Heroku	none
`systemCode`	(required) system code for your application as it's defined in Biz Ops	none
`scaling`	(required) configuration for dyno scaling with a quantity and size for each production app	none

Here's what your configuration might look like passing in the above options:

options:
  '@dotcom-tool-kit/heroku':
    pipeline: 'ft-next-static'
    systemCode: 'next-static'
    scaling:
      ft-next-static-eu:
        web:
          size: standard-1x
          quantity: 1

Hooks

Event	Description	Installed to...
`build:remote`	Compile any assets or code required for your app to run.	`heroku-postbuild` script in `package.json`
`release:remote`	Run any post-release tasks for an app that require a tool-kit task, e.g. upload assets to s3	`heroku-postbuild` script in `package.json`

Tasks

Task	Description	Preconfigured hooks
`HerokuProduction`	deploy production app to Heroku via CircleCi	`deploy:production`
`HerokuStaging`	deploy to staging	`deploy:staging`
`HerokuReview`	create and test Heroku review app	`deploy:review`
`HerokuTeardown`	scale down staging once smoke tests have been run	`teardown:staging`

@dotcom-tool-kit/heroku dependencies

@dotcom-tool-kit/doppler @dotcom-tool-kit/error @dotcom-tool-kit/logger @dotcom-tool-kit/npm @dotcom-tool-kit/options @dotcom-tool-kit/package-json-hook @dotcom-tool-kit/state @dotcom-tool-kit/types @dotcom-tool-kit/wait-for-ok @octokit/request @octokit/request-error heroku-client p-retry superagent tslib

@dotcom-tool-kit/heroku development dependencies

@types/financial-times__package-json @types/p-retry winston

FAQs

What is @dotcom-tool-kit/heroku?

This plugin handles deploying apps to Heroku. It also manages Tool Kit hooks that are run during Heroku builds. Visit Snyk Advisor to see a full health score report for @dotcom-tool-kit/heroku, including popularity, security, maintenance & community analysis.

Is @dotcom-tool-kit/heroku popular?

The npm package @dotcom-tool-kit/heroku receives a total of 470 weekly downloads. As such, @dotcom-tool-kit/heroku popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @dotcom-tool-kit/heroku well maintained?

We found that @dotcom-tool-kit/heroku demonstrated a healthy version release cadence and project activity. It has a community of 30 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @dotcom-tool-kit/heroku safe to use?

While scanning the latest version of @dotcom-tool-kit/heroku, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 25 July-2024, at 12:56 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (470)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

@dotcom-tool-kit/heroku

Installation

Options

Hooks

Tasks

@dotcom-tool-kit/heroku dependencies

@dotcom-tool-kit/heroku development dependencies

FAQs

What is @dotcom-tool-kit/heroku?

Is @dotcom-tool-kit/heroku popular?

Is @dotcom-tool-kit/heroku well maintained?

Is @dotcom-tool-kit/heroku safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues