Fix failure to properly escape & #46116
Merged
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR fixes a critical issue where the ampersand character (&) was not being properly encoded as & in HTML generated from README files, causing Javadoc compilation failures due to malformed HTML tags.
Key Changes
- Added HTML entity encoding for ampersand characters before processing README content
- Inserted the encoding step before the existing code snippet tag cleaning process
- Modified the downstream processing to use the escaped content
Comments suppressed due to low confidence (1)
eng/pipelines/scripts/generate_overview_from_readme.py:48
- [nitpick] The variable name 'escaped_readme_content_lines' could be more specific. Consider 'html_escaped_readme_content_lines' to clarify that this is HTML escaping, not general escaping.
escaped_readme_content_lines = []
jairmyree
changed the title
raych1
approved these changes
Jul 22, 2025
|
@alzimmermsft For the sake of time, I'm going to use this version of the PR to due this month's release of patches, and then I'll circle back to update with your suggestion. |
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.
Currently the script does not properly escape "&" when creating the readme html. This leads to the Javadoc compiler believing it is a malformed html tag.
This PR fixes the aforementioned issue.