Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

buildkite-collector

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

buildkite-collector

Buildkite Test Analytics collectors for JavaScript test frameworks

  • 1.0.0
  • unpublished
  • latest
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
0
Maintainers
1
Weekly downloads
 
Created
Source

Buildkite Collectors for JavaScript

Official JavaScript-based Buildkite Test Analytics collectors ✨

Supported test frameworks: Jest, and more coming soon.

📦 Supported CI systems: Buildkite, GitHub Actions, CircleCI, Jenkins, and others via the BUILDKITE_ANALYTICS_* environment variables.

👉 Installing

Jest

  1. Create a test suite, and copy the API token that it gives you.

  2. Add the buildkite-collector package:

    # If you use npm:
    npm install --save-dev buildkite-collector
    
    # or, if you use yarn:
    yarn add --dev buildkite-collector
    
  3. Update your Jest configuration:

      // jest.config.js
    
      // Send results to Test Analytics
      reporters: [
        'default',
        'buildkite-collector/jest/reporter'
      ],
    
      // Enable column + line capture for Test Analytics
      testLocationInResults: true
    
  4. Run your tests locally:

    env BUILDKITE_ANALYTICS_TOKEN=xyz npm test
    
  5. Add the BUILDKITE_ANALYTICS_TOKEN secret to your CI, push your changes to a branch, and open a pull request 🎉

    git checkout -b add-bk-test-analytics
    git commit -am "Add Buildkite Test Analytics"
    git push origin add-bk-test-analytics
    

🔍 Debugging

To enable debugging output, set the BUILDKITE_ANALYTICS_DEBUG_ENABLED environment variable to true.

🔜 Roadmap

See the GitHub 'enhancement' issues for planned features. Pull requests are always welcome, and we’ll give you feedback and guidance if you choose to contribute 💚

⚒ Developing

After cloning the repository, install the dependencies:

npm install

And run the tests:

npm test

Useful resources for developing collectors include the Buildkite Test Analytics docs and the RSpec and Minitest collectors.

👩‍💻 Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/buildkite/collector-javascript

📜 License

The package is available as open source under the terms of the MIT License.

Keywords

FAQs

Package last updated on 30 May 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc