@bcgov/gh-deploy
A cli and importable node module wrapper around the github deployments api
Last updated 9 months ago by patricksimonian .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @bcgov/gh-deploy 
SYNC missed versions from official npm registry.

Gh-Deploy

A simple CLI and node package that wraps creating github deployments and statuses

Github Deployments API docs can be found here

Why Wrap This as a CLI?

Creating Deployment Statuses are typically coupled to some type of automation in a pipeline. Most pipeline technologies have a way to run scripts under a NodeJS. Our organization has found it extremely useful to fire off single line scripts inside of our pipeline scripts because:

  • it is clear and readable
  • dependencies are not coupled to the pipeline technology

Startup

As A CLI

npx @bcgov/gh-deploy -h

  • Create Deployments @bcgov/gh-deploy deployment -h
  • View Pending Deployments @bcgov/gh-deploy pendingDeployments -h
  • Create Deployment Status @bcgov/gh-deploy status -h

As a Node Module

npm install --save @bcgov/gh-deploy

createDeployment

creates a deployment to a given environment

// in a js file

import { createDeployment } from '@bcgov/gh-deploy'

createDeployment({
  environment: 'production'
}, repo, owner, token)
.then(() => null);

createDeploymentStatus

creates a status for a specific deployment

// in a js file

import { createDeploymentStatus } from '@bcgov/gh-deploy'

createDeploymentStatus({
  state: 'success'
}, repo, owner, token)
.then(() => null);

getPendingDeployments

returns number of pending deployments

// in a js file

import { getPendingDeployments } from '@bcgov/gh-deploy'

getPendingDeployments({
  environment: 'production',
}, repo, owner, token)
.then(() => null);

Contributions Accepted

While the Contributions Docs are quite slim, I'm happy to take any PR's to improve this project.

Current Tags

  • 1.1.4                                ...           latest (5 months ago)

11 Versions

  • 1.1.4                                ...           5 months ago
  • 1.1.3                                ...           5 months ago
  • 1.1.2                                ...           5 months ago
  • 1.1.1                                ...           8 months ago
  • 1.1.0 [deprecated]           ...           8 months ago
  • 1.0.5                                ...           9 months ago
  • 1.0.4                                ...           9 months ago
  • 1.0.3                                ...           9 months ago
  • 1.0.2                                ...           9 months ago
  • 1.0.1                                ...           9 months ago
  • 1.0.0                                ...           9 months ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 0
Dependencies (5)
Dev Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |