@knapsack-pro/jest

@knapsack-pro/jest

Speed up your tests

Run your 1-hour test suite in 2 minutes with optimal parallelisation on your existing CI infrastructure

---

Knapsack Pro wraps Jest and works with your existing CI infrastructure to parallelize tests optimally:

• Dynamically splits your tests based on up-to-date test execution data
• Is designed from the ground up for CI and supports all of them
• Tracks your CI builds to detect bottlenecks
• Does not have access to your source code and collects minimal test data
• Enables you to export historical metrics about your CI builds
• Replaces local dependencies like Redis with an API and runs your tests regardless of network problems

Installation

See the docs to get started:

Dependencies

• @knapsack-pro/core

Contributing

Follow the steps in the root README.md to set up the project.

You can compile TypeScript in watch mode from the root folder with:

npm start -w packages/jest

Testing

To test @knapsack-pro/jest against a real test suite we use:

• jest-example-test-suite
• (deprecated) react

Publishing

1. cd packages/jest

2. Sign in to the npm registry with:

   npm adduser
   

3. Ensure you have the latest version of @knapsack-pro/core in package.json (do the change in a separate PR to have it appear in the CHANGELOG):

   {
     "dependencies": {
       "@knapsack-pro/core": "^x.x.x"
     }
   }
   

   and run npm install.

   Commit the updated package.json and package-lock.json:

   git commit -am "deps(jest): update @knapsack-pro/core"
   

4. Before releasing a new version of the package, please update CHANGELOG.md with github_changelog_generator:

   gem install github_changelog_generator
   
   # generate CHANGELOG.md
   github_changelog_generator --user KnapsackPro --project knapsack-pro-js --pr-wo-labels --issues-wo-labels --include-labels @knapsack-pro/jest --since-tag @knapsack-pro/jest@6.2.0 --exclude-tags-regex "@knapsack-pro\/(core|cypress)@.*"
   git commit -am "docs(jest): update CHANGELOG.md"
   git push origin main
   

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

6. Compile the project:

   npm run build
   

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

   # Bump patch version 0.0.x
   npm version patch --no-commit-hooks --tag-version-prefix=@knapsack-pro/jest@
   
   # Bump minor version 0.x.0
   npm version minor --no-commit-hooks --tag-version-prefix=@knapsack-pro/jest@
   

   git commit -am @knapsack-pro/jest@x.x.x
   git tag @knapsack-pro/jest@x.x.x
   

8. Push the commit and tag:

   git push origin main --tags
   

9. When the git tag is on Github, you can update CHANGELOG.md:

   github_changelog_generator --user KnapsackPro --project knapsack-pro-js --pr-wo-labels --issues-wo-labels --include-labels @knapsack-pro/jest --since-tag @knapsack-pro/jest@6.2.0 --exclude-tags-regex "@knapsack-pro\/(core|cypress)@.*"
   git commit -am "docs(jest): update CHANGELOG.md"
   git push origin main
   

10. Publish the package to the npm registry:

    npm publish
    

11. Update the latest available library version in:

    • TestSuiteClientVersionChecker for the Knapsack Pro API repository.
    • jest-example-test-suite