@knapsack-pro/core

@knapsack-pro/core is JS npm package with core features for Knapsack Pro API. Learn how to run your tests faster with optimal test suite parallelisation using Knapsack Pro.

Table of Contents

• Development
  • Setup
  • Publishing

Development

Setup

1. Install dependencies:

   $ npm install

2. Compile TypeScript code to lib directory by running:

   $ npm start

3. Register @knapsack-pro/core package globally in your local system. This way we will be able to develop other npm packages dependent on it:

   $ npm link

Publishing

1. Sign in to npm registry with command:

   $ npm adduser

2. Before releasing a new version of package please update CHANGELOG.md with github_changelog_generator:

   $ gem install github_changelog_generator
   
   # generate CHANGELOG.md
   $ github_changelog_generator KnapsackPro/knapsack-pro-core-js

3. If you have added new files to the repository and they should be part of the released npm package then please ensure they are included in files array in package.json.

4. If you have changed any headers in README.md please refresh table of contents with:

   $ npm run doctoc

5. Compile project:

   $ npm start

6. In order to bump version of the package run below command. It will also create a version commit and tag for the release:

   # bump patch version 0.0.x
   $ npm version patch
   
   # bump minor version 0.x.0
   $ npm version minor

7. Push to git repository created commit and tag:

   $ git push origin master --tags

8. Now when git tag is on Github you can update CHANGELOG.md again.

   $ github_changelog_generator KnapsackPro/knapsack-pro-core-js
   $ git commit -am "Update CHANGELOG.md"
   $ git push origin master

9. Now you can publish package to npm registry:

   $ npm publish