ci: add link and typo check#323
Conversation
Signed-off-by: Keming <kemingyang@tensorchord.ai>
✅ Deploy Preview for zh-envd ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for envd ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
This PR consolidates CI checks by replacing the standalone autocorrect workflow with a unified workflow that includes link checking and typo checking capabilities. The PR also updates documentation with corrected links and refreshes badge URLs.
- Adds typo checking and link checking configurations (
typos.tomlandlychee.toml) - Consolidates the autocorrect workflow into a new
check.ymlworkflow that includes spell checking and link checking - Updates Docker image specification links from deprecated moby/moby references to the current moby/docker-image-spec repository
Reviewed changes
Copilot reviewed 10 out of 10 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| typos.toml | New configuration file for typo checking with exclusions for SVG files and whitelisted words |
| lychee.toml | New configuration file for link checking with accepted status codes and URL exclusions |
| .github/workflows/check.yml | New consolidated workflow that combines autocorrect, spell checking, and link checking |
| .github/workflows/autocorrect.yml | Removed standalone autocorrect workflow (replaced by check.yml) |
| docs/guide/concepts.md | Updated Docker image spec link to point to current repository |
| docs/developers/development.md | Removed outdated documentation line referencing docker package |
| docs/community/community.md | Updated Discord badge URL to use shields.io instead of dcbadge.vercel.app |
| docs-zh/guide/concepts.md | Chinese version: Updated Docker image spec link |
| docs-zh/developers/development.md | Chinese version: Removed outdated documentation line |
| docs-zh/community/community.md | Chinese version: Updated Discord badge URL |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - main | ||
|
|
||
| jobs: | ||
| auto-correct: |
There was a problem hiding this comment.
[nitpick] The job name auto-correct is misleading as this job now performs multiple checks: auto-correction, spell checking, and link checking. Consider renaming to something more generic like lint-and-check or quality-checks to better reflect its purpose.
| auto-correct: | |
| lint-and-check: |
| accept = [ | ||
| "200..=204", | ||
| "403", # HuggingFace | ||
| "500..=599" |
There was a problem hiding this comment.
Accepting 5xx status codes (500-599) as valid links is problematic. These are server error responses and indicate that the links are broken or having issues. Consider removing this range from the accept list, as links returning server errors should be flagged for investigation.
| "500..=599" |
No description provided.