Skip to content

fix: use CheDocs AsciiDoc attributes instead of hardcoded terms on 7.122.x - #3196

Open
gtrivedi88 wants to merge 1 commit into
7.122.xfrom
fix-vale-attributes-7122x
Open

gtrivedi88 wants to merge 1 commit into
7.122.xfrom
fix-vale-attributes-7122x

Conversation

@gtrivedi88

Copy link
Copy Markdown
Contributor

Problem

The Call publication builder GitHub Action has been failing on every push to main since 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: main and 7.122.x. Each source's antora.yml registers a collector-extension run step for tools/validate_language_changes.sh, which lints git diff --name-only --diff-filter=AM origin/main with Vale, executed from that source's own checkout.

When that script runs from the 7.122.x checkout, it diffs against main and lints the files as they exist on 7.122.x. Several files on 7.122.x still contain hardcoded literal terms (Kubernetes, namespace, DevWorkspace) that were already converted to CheDocs AsciiDoc attributes ({kubernetes}, {orch-name}, {namespace}, {orch-namespace}, {devworkspace}) on main in earlier commits. That mismatch trips the hard-error CheDocs.Attributes Vale rule and fails the build with exit code 1, e.g.:

modules/secure/pages/security-best-practices.adoc
 114:2  error  Use the AsciiDoc attribute {devworkspace} rather than 'devworkspace.'  CheDocs.Attributes
 123:47 error  Use the AsciiDoc attribute {orch-namespace}, {platforms-namespace}, or {namespace} rather than ' namespace .'  CheDocs.Attributes
...
✖ 10 errors, 26 warnings and 0 suggestions in 20 files.
[FATAL] (antora): (@antora/collector-extension): Command failed with exit status 1: tools/validate_language_changes.sh (url: https://github.com/eclipse-che/che-docs | branch: 7.122.x)

Since the JTBD restructuring on main keeps moving/touching many files, the diff against 7.122.x keeps growing, surfacing more of these long-standing hardcoded terms on 7.122.x with every push.

Fix

Backport the exact attribute usage already present on main to 7.122.x for the 5 affected files, without touching anything else (no xref target changes, since main-only modules like integrate don't exist on this branch):

  • 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

Verification

$ vale <5 changed files>
Before: 9 errors, 56 warnings, 0 suggestions
After:  0 errors, 53 warnings, 0 suggestions

(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 how main already resolves it.)

No visible content changes: all swapped attributes resolve to the same literal text that was previously hardcoded.

Made with Cursor

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>
@gtrivedi88
gtrivedi88 requested review from nickboldt and removed request for a team September 30, 2026 13:05
@coderabbitai

coderabbitai Bot commented Sep 30, 2026

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Advanced

Run ID: 73d3c914-4916-417b-a8ac-8fc48d0f924f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

🎊 Navigate the preview: https://6abd0a02638a5c6f4edc0a41--eclipse-che-docs-pr.netlify.app 🎊

@github-actions

github-actions Bot commented Sep 30, 2026 •

Copy link
Copy Markdown

Click here to review and test in web IDE: Contribute

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant