add docs on potential conflicting gems with the collector #2513
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jasmine-q
requested review from
mbelton-buildkite,
MelissaKaulfuss and
meiqimichelle
as code owners
github-actions
bot
added
the
test-analytics
|
Preview URL: https://2513--bk-docs-preview.netlify.app |
| @@ -32,7 +32,7 @@ Before you start, make sure RSpec runs with access to [CI environment variables] | |||
| bundle | |||
| ``` | |||
|
|
|||
| 3. Add the Test Analytics code to your application in `spec/spec_helper.rb`, and set the BUILDKITE_ANALYTICS_TOKEN [securely](/docs/pipelines/secrets) on your agent or agents. | |||
| 3. Add the Test Analytics code to your application in `spec/spec_helper.rb`, and set the BUILDKITE_ANALYTICS_TOKEN [securely](/docs/pipelines/secrets) on your agent or agents. Please ensure gems that patch `Net::HTTP` like `httplog` and `sniffer` are required before `buildkite/test_collector` to avoid conflicts. | |||
There was a problem hiding this comment.
Are there links we could provide to the httplog and sniffer gems? That would help confirm what we're talking about for people.
There are also a couple of commas missing:
Suggested change
| 3. Add the Test Analytics code to your application in `spec/spec_helper.rb`, and set the BUILDKITE_ANALYTICS_TOKEN [securely](/docs/pipelines/secrets) on your agent or agents. Please ensure gems that patch `Net::HTTP` like `httplog` and `sniffer` are required before `buildkite/test_collector` to avoid conflicts. | |
| 3. Add the Test Analytics code to your application in `spec/spec_helper.rb`, and set the BUILDKITE_ANALYTICS_TOKEN [securely](/docs/pipelines/secrets) on your agent or agents. Please ensure gems that patch `Net::HTTP`, like `httplog` and `sniffer`, are required before `buildkite/test_collector` to avoid conflicts. |
There was a problem hiding this comment.
If there are links we can include, I'd recommend using them and removing the inline code formatting for the gem names.
There was a problem hiding this comment.
Thanks for the feedback, I've made changes to include your suggestions! 😄
mbelton-buildkite
approved these changes
Oct 13, 2023
jasmine-q
deleted the
pie-1493-write-documentation-on-what-to-do-for-potential-conflicting
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adding a small note to the ruby collectors to require potential conflicting gems before the TA test collector gem
Investigation and write up in Basecamp
Resolved Github issue