feat: add CI quality linting and weekly stale-content check#2
Merged
feat: add CI quality linting and weekly stale-content check#2
Conversation
Copilot
AI
changed the title
[WIP] Add weekly update check and CI quality flow
feat: add CI quality linting and weekly stale-content check
Mar 5, 2026
Co-authored-by: dsdeboer <17773117+dsdeboer@users.noreply.github.com>
- Add package.json with markdownlint-cli2 as dev dependency - Node 22.x and npm 11.x engine requirements - Provide npm scripts for local markdown linting and fixing - Update CI workflow to use npm for markdown linting with caching - Standardize weekly-update workflow to use npm scripts - Add CODEOWNERS file designating dsdeboer as reviewer - Set dsdeboer as reviewer for automated PRs
- Add validate-content.yml: Conventional Commits enforcement on PRs - Add monitor-best-practices.yml: Weekly check for dependency updates - Monitor Node.js LTS, markdownlint-cli2, and GitHub Actions versions - Create maintenance issues when updates are available - Assign dsdeboer for review of external best-practice changes
- Add @commitlint/cli and @commitlint/config-conventional to devDependencies - Add commitlint.config.js for Conventional Commits configuration - Replace bash validation with commitlint GitHub Action - Use npm ci and caching for improved CI performance
- Use npm outdated instead of complex external API calls - Improve shell script clarity and reliability - Focus on actionable dependency updates
- Add alex for inclusive language checking - Add markdown-link-check for link validation - Add retext for readability analysis - Create validate-best-practices.yml for PR validation - Create monitor-tech-changes.yml for dependency tracking - Add scripts/validate-readability.js for prose quality checking - All tools run via npm scripts for local validation support
- Bump Node.js engine requirement from 22.x to 25.x - Upgrade @commitlint/cli and @commitlint/config-conventional to version 20.4.3 - Update markdownlint-cli2 to version 0.21.0 - Upgrade retext to version 9.0.0 - Update retext-english to version 5.0.0 - Upgrade retext-readability to version 8.0.0
- Create validate-links.js with proper glob pattern handling - Create validate-skills.js as placeholder for knowledge-work - Update package.json scripts to use node-based wrappers
Replace embedded Node.js github-script action with standalone bash script using the gh CLI for issue creation. This simplifies workflows and makes them more maintainable. Changes: - monitor-tech-changes.yml: Use create-tech-update-issue.sh - Add .github/workflows/scripts/ directory with issue creation script Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Replace invalid --ignore-words flag with .alexrc.json configuration - Add comprehensive allow list for legitimate technical terms - Fix validate:inclusive script to only check content directories, not node_modules This resolves false positives for common technical terms like 'whitespace', 'execute', 'host', 'master', 'color', etc. that appear in legitimate technical documentation. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
d6a5e87 to
a8ba1ae
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds automated markdown/YAML linting on PRs and a weekly workflow that detects stale content and opens a review PR. All generated PRs request
charpandas reviewer.CI Quality (
.github/workflows/ci.yml)mainDavidAnson/markdownlint-cli2-action@v19) and yamllint (ibiqlik/action-yamllint@v3)permissions: contents: readWeekly Update Check (
.github/workflows/weekly-update.yml)workflow_dispatch.mdfiles with no git commit in 90+ days<!-- last-reviewed: YYYY-MM-DD -->(updates in-place on re-run)chore/weekly-update-<date>listing stale files, with--reviewer charpandLinter configuration
.markdownlint.yml: all rules on; MD013 (line length) disabled.yamllint.yml: extends default; 120-char line limit as warningPre-existing lint fixes
All 8 existing
.mdfiles updated to pass the new linting rules: blank lines around headings (MD022), list blocks (MD032), and fenced code blocks (MD031); language specifiers added to bare fences (MD040); bare URLs converted to links (MD034).Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.