fix: fixes are not applied to property deprecation messages #1765
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
We have logic in `fixupPropertyReference` to replace terraform resource references with pulumi references (i.e. `aws_s3_bucket` => `aws.s3.BucketV2`). This logic is applied to the `Description` property, but it is not applied to the separate `DeprecationMessage` property. These two properties exist separately in the pulumi resource schema and are combined when creating the website docs and the SDK docs. fixes #3028
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1765 +/- ##
==========================================
- Coverage 59.81% 59.44% -0.38%
==========================================
Files 300 309 +9
Lines 42032 42485 +453
==========================================
+ Hits 25142 25255 +113
- Misses 15467 15805 +338
- Partials 1423 1425 +2 ☔ View full report in Codecov by Sentry. |
t0yv0
reviewed
Mar 18, 2024
corymhall
commented
Mar 18, 2024
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.
We have logic in
fixupPropertyReferenceto replace terraform resource references with pulumi references (i.e.aws_s3_bucket=>aws.s3.BucketV2).This logic is applied to the
Descriptionproperty, but it is not applied to the separateDeprecationMessageproperty. These two properties exist separately in the pulumi resource schema and are combined when creating the website docs and the SDK docs.fixes #3028