Node Stage

Library to manage environment variables and stages.

Setup

1yarn add node-stage@poviolabs/node-stage#v2
2
3# update
4yarn up node-stage@poviolabs/node-stage#v2

Config.yaml Example

1
2stages:
3  myapp-dev: # one stage per deploy
4    
5    moduleName:
6      variableKey: variableValue
7  
8    ## dotenv overrides
9    # envFiles: [ '.env.myapp-dev.secrets' ]
10    ## environment overrides
11    # environment:
12    #  app__spaDeploy__s3__bucket: myapp-dev-website

Library

1import { loadConfig } from "node-stage";
2
3const config = await loadConfig("/path/to/config.yaml", process.env.STAGE);

CLI

Options

--pwd

Root from where to fetch config.yaml and the base for all relative paths.

--stage

The slug of the deployment (ie. myapp-prd/mystage-stg/mystage-dev). This is the base of the config set in conifg.yaml.

--release

Release of the build (ie the git sha) and is unique per code. Autodetected from most CI services or Git.

--releaseStrategy

Release is the id that services like Docker and Sentry will use to identify the build. Most of the time this is independent of the stage, but in some cases, we have a separate build per stage.

• gitsha - (default) make the same build for all stages
• gitsha-stage - make a build based on the stage and git sha in cases where the build is different per stage

--service

If the stage has multiple services, you can define the one you want to deploy here.

Example configuration

1stages:
2  myapp-prd: &myapp-prd
3    yaml_local_override: correct
4
5  myapp-prd-worker:
6    <<: *myapp-prd
7    stage: myapp-prd

Overriding config and global prefix

CONFIG_PREFIX=app CONFIG_FILE=config.yaml

Command node-stage env

node-stage env var [path-to-variable]

Fetches the variable at the specified path and returns it.

Example:

node-stage env var moduleName.variableKey

Development

Test CLI locally

Set up ./test/secrets.env with credentials to do a E2E test.

1# test with ts-node
2yarn test:ts-node:cli --help
3
4# build new version
5yarn build
6
7# test build
8yarn test:cli --help