@uplift-ltd/sammy

Installation

npm i --save @uplift-ltd/sammy

Getting Started

Prerequisites

Install doctl

MacOS:

brew install doctl

Ubuntu:

sudo snap install doctl

Authenticating with DigitalOcean

Generate an API token for the team you want to use.

doctl auth init --context uplift

You can log into multiple teams.

doctl auth init --context runbook

And switch between them:

doctl auth switch --context uplift

Configuring

In your project's package.json, set the context and app IDs.

{
  "sammy": {
    "context": "runbook",
    "apps": {
      "production": "DO APP ID",
      "staging": "ANOTHER DO APP ID"
    }
  }
}

File Structure

The CLI will create appspec.${env}.yml files. For examples:

appspec.production.yml
appspec.staging.yml

API

sammy appspec:get

Download and write the appspec yaml file for the specified environment.

sammy appspec:get --env production

sammy appspec:update

Upload the appspec yaml file for the specified environment to DigitalOcean.

sammy appspec:update --env production

sammy create-deployment

Trigger a new deployment.

sammy create-deployment --env production