npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

qa-deployer

v2.4.0

Published

Deploy a package to a hosting service for easy review

Downloads

25

Readme

qa-deployer -- Deploy a package to a hosting service for easy review

This package is used to easily deploy the contents of the current directory to an external service, and then optionally send one or more deployment notification.

The easiest way to use this package is with a CLI script (or writing your own). The module is used by specifying a deployer and notifiers:

var qa_deployer = require('qa-deployer');

qa_deployer.deploy({
  deployer: {
    service: 'modulus',
    auth: {username: 'me', password: '12345'},
    project: 'my-new-feature'
  },
  notifiers: [{
    service: 'github-pull-request',
    auth: {user: 'me', pass: '12345'},
    owner: 'SparkartGroupInc',
    repo: 'qa-deployer',
    pull_request: 1,
    comment: function(review_url) {
      return 'Ready for review at ' + review_url;
    }
  }]
});

Available Deployers

modulus

Deploys the current package to Modulus.

Usage

  • auth - An object with the Modulus account's username and password.
  • project - The Modulus project where to upload the package. If the project is missing, it will be automatically created. Optional, defaults to the current directory name.
  • include_modules - Whether to upload the node_modules folder. Optional, defaults to false.
  • env - An object with environment variables and their values to be set in the Modulus environment.

s3-static-website

Deploys the current directory to Amazon S3 as a static website.

Usage

  • s3_options - An object used to configure the connection to S3. See the AWS.S3 documentation.
  • bucket_name - The S3 bucket where to upload the files. If the bucket is missing, it will be automatically created and configured to host the static website. Optional, defaults to the current directory name.
  • region - The AWS region where the site will be hosted. Optional, defaults to us-east-1.
  • removeExtensions - List of extensions to remove from uploaded files, for example ['.html', '.htm']. Optional.
  • indexDocument - Default index document when a folder is requested from S3. Optional, defaults to index.html.

Available Notifiers

github-pull-request

Adds a comment to the specified GitHub pull request with the deployed URL.

Usage

  • auth - An object with the GitHub account's user and pass. The pass is a token which needs to have access to either the repo or public_repo scopes.
  • owner - The owner of the repo containing the pull request to comment on.
  • repo - The repo containing the pull request to comment on.
  • pull_request - The pull request number to comment on.
  • notify_redeploys - Whether to notify after the first deploy to the deployer service. Optional, defaults to false.
  • comment - A function called with the review_url as an argument, that returns the comment to add. Optional.

webhook

POSTs the deployed URL to a webhook URL, as JSON.

Usage

  • url - The webhook URL to POST to.
  • notify_redeploys - Whether to notify after the first deploy to the deployer service. Optional, defaults to false.
  • method - HTTP method to use: get, post or put. Optional, defaults to post.
  • headers - Object of HTTP headers to add to the request. Optional.
  • body - A function called with the review_url as an argument, that returns the JavaScript object to POST. Optional, defaults to {review_url: <review_url>}.

Available Scripts

circleci-deploy

Called by CircleCI, it automatically deploys a branch when a commit is made.

The following deployers are supported, with some usage changes:

  • modulus
  • project - Defaults to the GitHub branch, unless it is master.
  • s3-static-website
  • bucket_name - Defaults to the GitHub organization, repository and branch ([organization]-[repository]-[branch]), unless the branch is master.

Notifiers can be enabled by adding an options file. This JSON formatted file can contain deployer and notifier options, similar to the module usage above. For example:

{
  "deployer": {
    "service": "modulus",
    "include_modules": true,
    "env": {
      "NPM_AUTH_TOKEN": "sample-token-value"
    }
  },
  "notifiers": [
    {"service": "github-pull-request"},
    {"service": "webhook", "url": "http://my-webhook", "notify_redeploys": true}
  ]
}

The file can also be a Node module:

module.exports = {
  deployer: {
    service: 'modulus',
    include_modules: true
  },
  notifiers: [
    {service: 'github-pull-request'},
    {service: 'webhook', url: 'http://my-webhook', notify_redeploys: true}
  ]
};

Usage

Required environment variables:

  • GITHUB_USER
  • GITHUB_PASS

With the modulus deployer:

  • MODULUS_USERNAME
  • MODULUS_PASSWORD

With the s3-static-website deployer:

  • AWS_ACCESS_KEY_ID
  • AWS_SECRET_ACCESS_KEY

Command line options:

  • --deployer=SERVICE - The deployer to use. Optional, can also be set from the options file.
  • --options-from=FILE - Read additional options from FILE.

Example circle.yml configuration file:

dependencies:
  post:
    - npm install qa-deployer -g
deployment:
  production:
    branch: master
    commands:
      - circleci-deploy --options-from=production-deployer.json

circleci-deploy-github-pull-request

Similar to the circleci-deploy script, but will only deploy when an open GitHub pull request exists for the current branch. If not, the branch will not be deployed, and will be withdrawn from the deployer service instead.

Note: CircleCI will only trigger new builds when a commit is made to an existing pull request. To deploy a branch when a pull request is created (without pushing an extra commit), the CircleCI API needs to be called. On way to automatically do this is to create a PullRequestEvent Webhook in the GitHub project's settings. This Webhook will POST to a relay service, such as Zapier, which will in turn POST to the appropriate CircleCI API URL.

Example circle.yml configuration file:

dependencies:
  post:
    - npm install qa-deployer -g
deployment:
  qa:
    branch: /^(?!master$)(.+)/
    commands:
      - circleci-deploy-github-pull-request --options-from=qa-deployer.json

circleci-withdraw-closed-github-pull-requests

The circleci-deploy-github-pull-request script withdraws the current branch from the deployer service when its corresponding GitHub pull request is closed. Unfortunately, CircleCI does not run a build when a branch is deleted, so the withdrawal never happens when a GitHub pull request is closed and its branch is deleted at the same time.

This script takes care of that missed cleanup: it retrieves a list of all closed GitHub pull requests, and withdraws all matching projects from the deployer service.

Example circle.yml configuration file, to cleanup old projects whenever commits are made to master:

dependencies:
  post:
    - npm install qa-deployer -g
deployment:
  production:
    branch: master
    commands:
      - circleci-deploy --options-from=production-deployer.json
      - circleci-withdraw-closed-github-pull-requests --options-from=production-deployer.json