Official Buildkite Test Analytics collectors for Ruby test frameworks β¨
β Supported test frameworks: RSpec, Minitest, and more coming soon.
π¦ Supported CI systems: Buildkite, GitHub Actions, CircleCI, and others via the BUILDKITE_ANALYTICS_*
environment variables.
Create a test suite, and copy the API token that it gives you.
Add the buildkite-test_collector
gem:
gem install buildkite-test_collector
Or add this to your Gemfileβs test group:
group :test do
gem "buildkite-test_collector"
end
Add the following code to your RSpec setup file:
# spec/spec_helper.rb
require "buildkite/test_collector"
Buildkite::TestCollector.configure(hook: :rspec)
Run your tests locally:
BUILDKITE_ANALYTICS_TOKEN=xyz rspec
Add the following code to your Minitest setup file:
# test/test_helper.rb
require "buildkite/test_collector"
Buildkite::TestCollector.configure(hook: :minitest)
Run your tests locally:
BUILDKITE_ANALYTICS_TOKEN=xyz rake
Add the BUILDKITE_ANALYTICS_TOKEN
secret to your CI, push your changes to a branch, and open a pull request π
git checkout -b add-buildkite-test-analytics
git commit -am "Add Buildkite Test Analytics"
git push origin add-buildkite-test-analytics
To enable debugging output, set the BUILDKITE_ANALYTICS_DEBUG_ENABLED
environment variable to true
.
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 π
After cloning the repository, install the dependencies:
bundle
And run the tests:
bundle exec rspec
Useful resources for developing collectors include the Buildkite Test Analytics docs.
Bug reports and pull requests are welcome on GitHub at https://github.com/buildkite/test-collector-ruby
The gem is available as open source under the terms of the MIT License.