Skip to content

[TECH] feat(ci): add grammar check workflow using LanguageTool - #1326

Open
cernus76 wants to merge 3 commits into
devfrom
workflow-to-check-grammar
Open

cernus76 wants to merge 3 commits into
devfrom
workflow-to-check-grammar

Conversation

@cernus76

@cernus76 cernus76 commented Oct 9, 2026

Copy link
Copy Markdown
Contributor

Warning

You are about to make a PR to the EXTERNAL Architecture Center.
Please review the contents of your PR carefully. Some information
may be subject to embargo and must not be disclosed publicly before
the designated release date.

Add a new GitHub Actions workflow that lints prose in docs/ and news/ Markdown files using LanguageTool via reviewdog. Key design decisions:

  • Non-blocking by design: never fails the check, posts findings as inline PR review comments (warnings only)
  • Spelling disabled (TYPOS category) to avoid overlap with cspell
  • Runs across en, en-GB, and en-US locales via job matrix
  • Excludes .mdx files to avoid JSX-related false positives
  • Fork PRs gracefully degrade (read-only token, findings in logs)
  • Includes tuning notes and a curated set of disabled rules to reduce noise from Markdown syntax artifacts

Note

Feel free to contact the administrators if you have any questions.

Add a new GitHub Actions workflow that lints prose in docs/ and news/
Markdown files using LanguageTool via reviewdog. Key design decisions:

- Non-blocking by design: never fails the check, posts findings as
  inline PR review comments (warnings only)
- Spelling disabled (TYPOS category) to avoid overlap with cspell
- Runs across en, en-GB, and en-US locales via job matrix
- Excludes .mdx files to avoid JSX-related false positives
- Fork PRs gracefully degrade (read-only token, findings in logs)
- Includes tuning notes and a curated set of disabled rules to
  reduce noise from Markdown syntax artifacts
@hyperspace-pr-bot

Copy link
Copy Markdown
Contributor

Summary

The following content is AI-generated and provides a summary of the pull request:


Warning

You are about to make a PR to the EXTERNAL Architecture Center.
Please review the contents of your PR carefully. Some information
may be subject to embargo and must not be disclosed publicly before
the designated release date.

Which content does this PR apply to? (Enter a short description)

Title: Add non-blocking LanguageTool grammar checks for Markdown

Category: New Feature

Adds a GitHub Actions workflow that checks prose in docs/ and news/ Markdown files with LanguageTool and reports warnings through reviewdog.

  • Runs for pull requests targeting dev when relevant Markdown or workflow files change.
  • Checks en, en-GB, and en-US locales.
  • Posts inline review comments without blocking merges.
  • Keeps spelling checks in cspell by disabling LanguageTool typo rules.
  • Excludes MDX and suppresses noisy Markdown-related rules.
  • Uses pinned action versions, minimal permissions, and a 15-minute timeout.
  • Gracefully handles fork permission limitations and service errors.

Who should review your contribution? (Use @mention to be more specific)

Architecture Center maintainers and repository CI/workflow owners.

Checklist before submitting

  • My commits are only for the content mentioned above.
  • I have followed the folder structure described in the Community Guidelines

Note

Feel free to contact the administrators if you have any questions.


  • 🔄 Regenerate and Update Summary
  • ✏️ Insert as PR Description (deletes this comment)
  • 🗑️ Delete comment
PR Bot Information

Version: 1.32.6

  • File Content Strategy: Full file content
  • LLM: gpt-5.6-sol
  • Output Template: Repository PR Template
  • Event Trigger: pull_request.opened
  • Summary Prompt: Default Prompt
  • Correlation ID: 49c47c20-c3d5-11f1-9106-5040aa094178

@hyperspace-pr-bot hyperspace-pr-bot Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The workflow is generally clear and carefully scoped, but its branch filter leaves direct content pull requests to main without grammar validation. Aligning it with the repository’s other content checks will provide consistent coverage.

PR Bot Information

Version: 1.32.6

  • File Content Strategy: Full file content
  • LLM: gpt-5.6-sol
  • Event Trigger: pull_request.opened
  • Correlation ID: 49c47c20-c3d5-11f1-9106-5040aa094178
  • Agent Instructions:

Comment thread .github/workflows/check-grammar.yml
@cernus76 cernus76 changed the title feat(ci): add grammar check workflow using LanguageTool [TECH] feat(ci): add grammar check workflow using LanguageTool Oct 9, 2026

This branch has not been deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant