Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 1.25 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.25 KB

Contributing

Requirements

  • node (tested with 12.x, 14.x, 16.x, and 18.x)
  • typescript (tested with 4.5.x)
  • yarn (tested with 1.22.10)
  • lerna (tested with 8.1.2)
  • jest (tested with 27.4.7)

Commands

  1. Install depencencies with Lerna v7+ (automatic in DevContainer)
yarn install
  1. Build with
yarn build
  1. Test with
yarn test
# or with coverage
jest --coverage
  1. Clean dependencies and built files
yarn clean

Publishing

Make sure that git remote origin points to [email protected]:finnair/v-validation.git.

Publishing uses @lerna/version and @lerna/publish.

Publishing requires npm credentials with access to finnair organization and GH_TOKEN environment variable, i.e. your GitHub authentication token for public_repo scope (under Settings > Developer settings > Personal access tokens).

./publish.sh [patch|minor|major]

After publishing to NPM, check/update CHANGELOG.md files and draft a Github Release manually.