Skip to content

Latest commit

 

History

History
54 lines (37 loc) · 1.49 KB

developer_guide.md

File metadata and controls

54 lines (37 loc) · 1.49 KB
Raw

Developer guide

Requirements

  • NodeJS
  • Docker

Linting

npm run lint // Will autofix issues
npm run lint:ci // No autofix enabled

Unit tests

npm run test # Runs both test in parallel
npm run test:dom
npm run test:node

Integration tests

npm run itest # Runs both test in parallel
npm run itest:dom
npm run itest:node

MacOS

If you're using Docker Desktop, please set

export DOCKER_HOST=unix:///Users/$(whoami)/Library/Containers/com.docker.docker/Data/docker.raw.sock

Testing your changes locally before publishing

You can use npm install <directory of this project> to install the driver locally in your other node test projects. Don't forget to (re)build the driver using npm run build to see your changes reflected. In case of unexplainable errors in your tests it might help to remove the entire /dist folder before rebuilding.

Release Process

  • Run project-keeper and release-droid to create a GitHub release draft as you usually would.
  • Upon publishing the draft release on github the release workflow for npm will be triggered.

More info on the release workflow.

  • The npm token is kept in a secret, then set as an environment variable in the release.yml workflow.
  • The added .npmrc file contains a setting that enables reading out this environment variable while publishing.
  • For a scoped release you need to explicitly specify that you wish to release a public release using publish --access public.