Skip to content

Latest commit

 

History

History
58 lines (42 loc) · 1.5 KB

README.md

File metadata and controls

58 lines (42 loc) · 1.5 KB
Raw

watcloud-emails

A collection of email templates used by WATcloud.

Getting started

  1. Find a version from the releases page (e.g. 0.0.2).
  2. Run the following command 
    VERSION=<version>
npx https://github.com/WATonomous/watcloud-emails/releases/download/v${VERSION}/watonomous-watcloud-emails-${VERSION}.tgz --help

Development

Emails

npm ci
npm run dev

Open localhost:3000 with your browser to see email previews.

CLI

npm run build
node ./dist/cli/index.js

Packaging the CLI

npm run build
npm version --no-git-tag-version 0.0.0-dev
npm pack --pack-destination .

A watonomous-watcloud-emails-0.0.0-dev.tgz file will be created in the current directory. Use it as follows:

npx watonomous-watcloud-emails-0.0.0-dev.tgz --help
# or
npm install -g watonomous-watcloud-emails-0.0.0-dev.tgz
watcloud-emails --help

Releasing

Releases are manually created from the Releases page. CI will automatically build the tarball and publish it to the release page. Release notes can be auto-generated via the web interface.

Please follow semantic versioning when creating tags for releases. Tags should be prefixed with v (e.g. v1.0.0). Version numbers less than 1.0.0 should be considered unstable and may have breaking changes in minor versions.