fix: use CheDocs AsciiDoc attributes instead of hardcoded terms on 7.122.x - #3196
gtrivedi88 wants to merge 1 commit into
Conversation
The publication builder (Antora collector-extension) runs
tools/validate_language_changes.sh against files that differ between
this branch and main. Several files on 7.122.x still used hardcoded
literal text ('Kubernetes', 'namespace', 'DevWorkspace') instead of
the CheDocs AsciiDoc attributes ({kubernetes}, {orch-name},
{namespace}, {orch-namespace}, {devworkspace}), which main already
uses. This tripped the CheDocs.Attributes Vale error rule and failed
the 'Call publication builder' workflow on every push to main:
https://github.com/eclipse-che/che-docs/actions/runs/36716048911
Backport the same attribute usage already present on main to
7.122.x, mirroring the exact wording used there:
- modules/administration-guide/pages/configuring-a-user-namespace.adoc
- modules/administration-guide/pages/devworkspace-backup.adoc
- modules/administration-guide/pages/managing-workloads-using-the-che-server-api.adoc
- modules/get-started-user/pages/using-a-git-provider-access-token.adoc
- modules/secure/pages/security-best-practices.adoc
Verified with: vale <changed files> -> 0 errors (was 10 errors).
Co-authored-by: Cursor <cursoragent@cursor.com>
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
🎊 Navigate the preview: https://6abd0a02638a5c6f4edc0a41--eclipse-che-docs-pr.netlify.app 🎊 |
Problem
The
Call publication builderGitHub Action has been failing on every push tomainsince PR #3151 (Integrate), and again after #3143 (Extend) and #3153 (Develop):Root cause
The publication Antora playbook (
publication-builder-antora-playbook.yml) builds from two content sources:mainand7.122.x. Each source'santora.ymlregisters a collector-extensionrunstep fortools/validate_language_changes.sh, which lintsgit diff --name-only --diff-filter=AM origin/mainwith Vale, executed from that source's own checkout.When that script runs from the 7.122.x checkout, it diffs against
mainand lints the files as they exist on 7.122.x. Several files on7.122.xstill contain hardcoded literal terms (Kubernetes,namespace,DevWorkspace) that were already converted to CheDocs AsciiDoc attributes ({kubernetes},{orch-name},{namespace},{orch-namespace},{devworkspace}) onmainin earlier commits. That mismatch trips the hard-errorCheDocs.AttributesVale rule and fails the build with exit code 1, e.g.:Since the JTBD restructuring on
mainkeeps moving/touching many files, the diff against7.122.xkeeps growing, surfacing more of these long-standing hardcoded terms on7.122.xwith every push.Fix
Backport the exact attribute usage already present on
mainto7.122.xfor the 5 affected files, without touching anything else (no xref target changes, sincemain-only modules likeintegratedon't exist on this branch):modules/administration-guide/pages/configuring-a-user-namespace.adocmodules/administration-guide/pages/devworkspace-backup.adocmodules/administration-guide/pages/managing-workloads-using-the-che-server-api.adocmodules/get-started-user/pages/using-a-git-provider-access-token.adocmodules/secure/pages/security-best-practices.adocVerification
(Locally reproduced 9 of the 10 CI-reported errors verbatim, same file/line/column/message; the 10th, line 12 of
configuring-a-user-namespace.adoc, is fixed identically to howmainalready resolves it.)No visible content changes: all swapped attributes resolve to the same literal text that was previously hardcoded.
Made with Cursor