Do not fail conversion of non-HCL fenced markdown snippets #1842
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
The documentation pipeline was looking for Markdown code-fenced blocks. In the case where they specify terraform or hcl as the language, it is clear that they should be converted. However the unmarked blocks may be carrying code that needs to be converted or else they can be carrying text that needs to be displayed with a fixed font. This change introduces a regex-based guess that allows non-Terraform code snippets to pass through as-is. Fixes the following AWS build warnings (107 total): ``` 1 warning: failed to convert HCL for #/types/aws:autoscaling/GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirements:GroupMixedInstancesPolicyLaunchTemplateOverrideInstanceRequirements/acceleratorManufacturers to csharp: <nil>: unexpected HCL snippet in Convert; ```
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1842 +/- ##
==========================================
- Coverage 60.82% 60.37% -0.45%
==========================================
Files 303 310 +7
Lines 42426 42809 +383
==========================================
+ Hits 25804 25846 +42
- Misses 15149 15500 +351
+ Partials 1473 1463 -10 ☔ View full report in Codecov by Sentry. |
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.
Fix #1839
The documentation pipeline was looking for Markdown code-fenced blocks. In the case where they specify terraform or hcl
as the language, it is clear that they should be converted. However the unmarked blocks may be carrying code that needs
to be converted or else they can be carrying text that needs to be displayed with a fixed font.
This change introduces a regex-based guess that allows non-Terraform code snippets to pass through as-is.
Fixes the following AWS build warnings (107-118 total, getting numbers a bit mixed up):