XS ◾ Code Change - Auto-fix category index sync on PRs when rule category changes

[Copilot]

Relates to SSWConsulting/SSW.Rules#2473

This pull request introduces a new automated workflow and supporting scripts to ensure category index files stay in sync with rule files. The main addition is a GitHub Actions workflow that runs on pull requests to automatically check and fix discrepancies between rule frontmatter and category index lists. The workflow leverages a new Node.js script for validation and auto-fixing, and includes necessary dependency setup.

Automation for category index synchronization:

• Added .github/workflows/check-category-sync.yml workflow to automatically check and fix category index synchronization on pull requests targeting main. The workflow installs Node.js, detects changed files, runs the sync validator, and commits any auto-fixed changes.
• Introduced scripts/category-sync-validator/category-sync-validator.js, a Node.js script that parses rule and category files, ensures category index lists include referenced rules, removes stale entries, and reports errors.

[Aibono1225]

@copilot

Change the workflow so that, on PRs, it auto-fixes category index sync issues instead of posting PR review comments.

Auto-fix behavior:

• For each changed rule MDX, read its categories frontmatter and ensure every referenced category MDX index includes - rule: <rulePath>.
• If missing, update the category file by inserting the entry (preserve existing formatting/order if possible; otherwise append).
• If the category file does not exist or the frontmatter cannot be parsed, fail with a clear error (do NOT try to create new category files).

Workflow behavior:

• Run the fixer script.
• If it produced changes, commit them back to the PR branch (use github-actions bot) and push.
• Then re-run the validator (or have the fixer exit cleanly and let the job pass).
• Remove the “post PR comment on failure” step.

[Copilot]

@copilot

Change the workflow so that, on PRs, it auto-fixes category index sync issues instead of posting PR review comments.
...

Done in 9393be8. The script now auto-fixes category index sync issues by inserting missing - rule: entries into category MDX files (appending after the last existing entry to preserve formatting). The workflow commits and pushes changes back to the PR branch using github-actions[bot]. Non-fixable issues (missing or unparseable category files) still fail the job with a clear error. PR comment steps have been removed.

[github-actions]

PR Metrics

✔ Thanks for keeping your pull request small.

	Lines
Product Code	-
Test Code	-
Subtotal	-
Ignored Code	411
Total	411

Metrics computed by PR Metrics. Add it to your Azure DevOps and GitHub PRs!

[Copilot]

Pull request overview

Adds an automated PR check + fixer to keep category index MDX files in sync with rule frontmatter categories, preventing rules from disappearing from the Categories page when category metadata changes.

Changes:

• Added a GitHub Actions workflow to detect changed rule MDX files, run a sync fixer, and auto-commit resulting category index updates back to the PR branch.
• Added a Node.js validator/fixer script that inserts missing - rule: entries into category index frontmatter (and removes stale ones).
• Added minimal npm dependency setup for the validator script.

Reviewed changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 6 comments.

File	Description
.github/workflows/check-category-sync.yml	Runs validator on PRs and auto-commits category index fixes back to the PR branch.
scripts/category-sync-validator/category-sync-validator.js	Implements frontmatter parsing and category index add/remove sync logic.
scripts/category-sync-validator/package.json	Declares js-yaml dependency for parsing frontmatter.
scripts/category-sync-validator/.gitignore	Ignores local node_modules/ for the script folder.

Files not reviewed (1)

• scripts/category-sync-validator/package-lock.json: Language not supported