chore(ci): add quality-checks workflow + pre-commit#391
Merged
jmelahman merged 5 commits intoMay 13, 2026
Conversation
Adds a docs-focused subset of the Onyx quality-checks workflow. Pre-commit runs format_docs.py on changed MDX, prettier on JSON/CSS, actionlint, ripsecrets, and a large-files guard (10MB to fit the existing asset profile). CI runs prek (PR diff / merge_group diff / --all-files on main) plus check-actions. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
Pure line-wrap/whitespace changes produced by running `python scripts/format_docs.py --write`. No content edits. Required so the newly-added format_docs.py pre-commit hook passes on main with --all-files. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
…chore-add-ci-quality-checks
The v3.1.0/v3.2.0 entries merged from main don't match format_docs.py's wrap rules; CI catches them because actions/checkout checks out the PR merge ref. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
justin-tahara
approved these changes
May 13, 2026
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
2 participants
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.
Summary
.github/workflows/quality-checks.yml: a docs-focused trim of the standard Onyx quality-checks workflow. Triggers on PR / push(main) / merge_group. Steps: checkout → setup-python 3.11 →j178/prek-action(with--from-ref/--to-refdiff logic on PR + merge_group,--all-fileson main) →giner/check-actions. Drops the node/terraform/uv setup steps since nothing here needs them..pre-commit-config.yamlwith:check-added-large-files(10MB — existing screenshots run up to ~9MB, so 1500kb from the reference would have been too aggressive),actionlint,prettier(JSON + CSS only — MDX intentionally excluded so prettier doesn't fightscripts/format_docs.py),ripsecrets, and a localformat_docs.py --check --pathshook on changed.md/.mdxfiles. Upstream hooks pinned to the same SHAs the reference uses.scripts/format_docs.py --writeso the new check passes on main. Pure line-wrap/whitespace; no content edits.Skipped from the reference (not applicable to a docs-only repo):
uv-sync/uv-lock/uv-export(no pyproject.toml/uv.lock),golangci-lint,terraform-fmt,shellcheck,npm-install*,typescript-check,ruff/black/ty(only one Python script, not worth the tooling).Test plan
base..headdiff).push: branches: mainrun with--all-filesis green.check-actionspasses against.github/workflows/quality-checks.yml.🤖 Generated with Claude Code