fix: escape shell variables in cluster-roles source blocks - #3173
Merged
Conversation
gtrivedi88
requested review from
a team,
deerskindoll and
mkuznyetsov
as code owners
July 28, 2026 07:38
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
|
🎊 Navigate the preview: https://6a6861676fe6bc4723593cef--eclipse-che-docs-pr.netlify.app 🎊 |
The Secure audit PR (eclipse-che#3159) added +attributes to source blocks that contain shell variables ${USER_ROLES} and ${OPERATOR_NAMESPACE}. Asciidoctor tried to resolve these as AsciiDoc attributes, causing "missing attribute" warnings that fail the publication builder. Escape with backslash so Asciidoctor renders them literally while still resolving {orch-cli} and {prod-operator}. Co-authored-by: Cursor <cursoragent@cursor.com>
ibuziuk
approved these changes
Jul 28, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
${USER_ROLES}and${OPERATOR_NAMESPACE}in cluster-roles source blocks to prevent Asciidoctor from resolving them as AsciiDoc attributesRoot cause
PR #3159 added
+attributesto source blocks that contain shell variables. This was needed so{orch-cli}resolves correctly (replacing hardcodedkubectl). But it also caused Asciidoctor to try resolving${USER_ROLES}and${OPERATOR_NAMESPACE}as attributes, producing "missing attribute" warnings that fail the publication builder.Fix
Escape with backslash (
$\{USER_ROLES},$\{OPERATOR_NAMESPACE}) so Asciidoctor renders them literally while still resolving{orch-cli}and{prod-operator}.Made with Cursor