[CIVIS-2985] upgrade guide for 1.0 #163
Merged
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
…guide for users upgrading from ddtrace
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #163 +/- ##
=======================================
Coverage 99.05% 99.05%
=======================================
Files 196 196
Lines 9340 9340
Branches 404 404
=======================================
Hits 9252 9252
Misses 88 88 ☔ View full report in Codecov by Sentry. |
juan-fernandez
approved these changes
Apr 23, 2024
Co-authored-by: Juan Antonio Fernández de Alba <juan.fernandezdealba@datadoghq.com>
Co-authored-by: Juan Antonio Fernández de Alba <juan.fernandezdealba@datadoghq.com>
Co-authored-by: Juan Antonio Fernández de Alba <juan.fernandezdealba@datadoghq.com>
romainkomorndatadog
approved these changes
Apr 23, 2024
README.md
Outdated
| @@ -212,15 +201,15 @@ VCR.configure do |config| | |||
|
|
|||
| # when using agentless mode | |||
| # note to use the correct datadog site (e.g. datadoghq.eu, etc) | |||
| config.ignore_hosts "citestcycle-intake.datadoghq.com", "api.datadoghq.com" | |||
| config.ignore_hosts "citestcycle-intake.datadoghq.com", "api.datadoghq.com", "citestcov-intake.datadoghq.com" | |||
There was a problem hiding this comment.
Just out of curiosity, how does this interact with our staging endpoints?
There was a problem hiding this comment.
Our users do not hit staging endpoints so there is no need to include it in the docs. When I use open source porject that uses VCR, I add all the endpoints I need to ignore in project's configs.
docs/UpgradeGuide.md
Outdated
| ```ruby | ||
| VCR.configure do |config| | ||
| # note to use the correct datadog site (e.g. datadoghq.eu, etc) | ||
| config.ignore_hosts "citestcycle-intake.datadoghq.com", "api.datadoghq.com", "citestcov-intake.datadoghq.com" |
There was a problem hiding this comment.
TIL... maybe I can use this in Python if vcrpy uses it. :D
docs/UpgradeGuide.md
Outdated
|
|
||
| ## Change WebMock or VCR configuration | ||
|
|
||
| We work on adding new features to the test visibility product in Ruby (intelligent test runner, git metadata upload, code coverage support) that require new endpoints being allowlisted by WebMock/VCR tools when using agentless mode. |
There was a problem hiding this comment.
Suggested change
| We work on adding new features to the test visibility product in Ruby (intelligent test runner, git metadata upload, code coverage support) that require new endpoints being allowlisted by WebMock/VCR tools when using agentless mode. | |
| Ongoing work on new features to the test visibility product (intelligent test runner, git metadata upload, code coverage support) require new endpoints being allowlisted by WebMock/VCR tools when using agentless mode. |
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.
What does this PR do?
Adds upgrade guide for users upgrading from ddtrace gem and updates readme.
Motivation
Next major release for Datadog ruby libraries is coming