Skip to content

Latest commit

 

History

History
59 lines (40 loc) · 1.08 KB

DEVELOPMENT.md

File metadata and controls

59 lines (40 loc) · 1.08 KB
Raw

Development Guide

Prerequisites

Install dependencies

npm install

Package

npm run package:watch

Test

npm test

Run locally

npm run all
node dist/index.js

Release

1. Update the version

It is necessary to manually update, commit and push the version in the package.json file. Normally, the version should be updated according to the Semantic Versioning. And this happens in a pull request.

Note: Only step 1 is necessary for a pull request.

2. Tag and push the new release

After that a helper script is available to streamline the process of tagging and pushing new releases for GitHub Actions.

It performs the following steps:

  1. Get the latest release tag
  2. Prompt the user for a new release tag (while displaying the latest release tag, and a regular expression to validate the new tag)
  3. Tag the new release
  4. Push the new tag to the remote
./scripts/release.sh