Add doc lint workflow to gate releases#2
Merged
darylcecile merged 2 commits intomainfrom Mar 24, 2026
Merged
Conversation
- Create .github/workflows/doc-lint.yml to lint docs on PRs to main - Add doc-lint job to release.yml that must pass before npm publish - Uses existing gh-doccy setup (docs:lint script + .doccyrc.yaml) Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Matches the pattern from darylcecile/gh-doccy's own lint-docs workflow: install the gh extension and run 'gh doccy lint' directly, no bun/npm needed. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
1 participant
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.
Documentation issues (spelling, broken links, staleness) can silently ship with releases since the existing CI only runs tests and type-checks. This adds doc linting as a CI gate so problems are caught before merge and before publish.
Approach
doc-lint.ymlworkflow — runsbun run docs:lint(viagh-doccy) on pull requests targetingmain, giving early feedback on doc quality.doc-lintjob inrelease.yml— runs in parallel withtestaftercheck-version, and is required bynpm-publish. Broken docs now block the release.Both use the existing
gh-doccysetup (.doccyrc.yaml+docs:lintscript) — no new dependencies.