Skip to content

Scope CI spell-check to README and HISTORY - #512

Merged
ptr727 merged 1 commit into
developfrom
fix/cspell-ci-scope-readme-history
Jul 15, 2026
Merged

Scope CI spell-check to README and HISTORY#512
ptr727 merged 1 commit into
developfrom
fix/cspell-ci-scope-readme-history

Conversation

@ptr727

@ptr727 ptr727 commented Jul 15, 2026

Copy link
Copy Markdown
Owner

Narrows the CI cspell (spell-check) step in .github/workflows/validate-task.yml from all markdown (**/*.md) to just README.md + HISTORY.md.

Matches the template default in ptr727/ProjectTemplate#302: spell-checking every markdown file forces endlessly padding cspell.json with technical terms. Restricting the gate to the two files every repo visitor sees keeps CI meaningful, while broad live spell-checking stays the editor extension's job.

  • markdownlint stays repo-wide (**/*.md) - unchanged.
  • Local actionlint (rhysd/actionlint:latest) is clean, no findings.

🤖 Generated with Claude Code

Match the template default (ptr727/ProjectTemplate#302): the CI cspell
gate covered all markdown, which forces endlessly padding cspell.json
for technical terms. Narrow it to README.md + HISTORY.md - the files
every repo visitor sees; broad live spell-checking stays the editor
extension's job. markdownlint stays repo-wide.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings July 15, 2026 16:02

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

This PR narrows the CI spell-check gate in .github/workflows/validate-task.yml so cspell runs only against the two primary visitor-facing docs (README.md and HISTORY.md), while keeping markdownlint repo-wide.

Changes:

  • Update the cspell-action files input from **/*.md to a multiline list containing README.md and HISTORY.md.
  • Leave the existing repo-wide Markdown linting (markdownlint globs **/*.md) unchanged.

@codecov

codecov Bot commented Jul 15, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.28%. Comparing base (d5d9847) to head (dfbd334).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #512   +/-   ##
========================================
  Coverage    57.28%   57.28%           
========================================
  Files           15       15           
  Lines         1386     1386           
  Branches        89       89           
========================================
  Hits           794      794           
  Misses         573      573           
  Partials        19       19           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ptr727
ptr727 merged commit 1509a7f into develop Jul 15, 2026
14 checks passed
@ptr727
ptr727 deleted the fix/cspell-ci-scope-readme-history branch July 15, 2026 16:11
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.

2 participants