-
Notifications
You must be signed in to change notification settings - Fork 1
feat: doc frontmatter validation, v0.43.2 review JSON gate, and pre-commit review UX #463
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
17ee3c5
chore(release): v0.43.2 pre-commit review JSON + OpenSpec dogfood rules
djm81 3f2592e
fix: CodeRabbit — changelog, openspec TDD_EVIDENCE freshness, review …
djm81 2ac5660
Add code review to pre-commit and frontmatter docs validation
djm81 0ef4abc
Improve pre-commit script output
djm81 af76c54
Improve specfact code review findings output
djm81 2e80475
Fix review findings
djm81 7371fef
Improve pre-commit hook output
djm81 4acca00
Enable dev branch code review
djm81 7fefb57
Update code review hook
djm81 292ec46
Fix contract review findings
djm81 4129c53
Fix review findings
djm81 6322d6a
Fix review warnings
djm81 dff0587
feat: doc frontmatter hardening and code-review gate fixes
djm81 86ae42a
Fix test failures and add docs review to github action runner
djm81 879dd97
Fix test failure due to UTF8 encoding
djm81 7d64a65
Apply review findings
djm81 169906d
Optimize pr orchestrator runtime
djm81 ce609db
Optimize pr orchestrator runtime
djm81 d202d73
Fix caching on pr-orchestrator
djm81 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,105 @@ | ||
| # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json | ||
| # | ||
| # CodeRabbit aligns with AGENTS.md: contract-first APIs, OpenSpec, Hatch quality gates. | ||
| # `reviews.auto_review.base_branches` includes `dev` so PRs into `dev` are auto-reviewed (not only the | ||
| # repo default branch). See https://docs.coderabbit.ai/reference/configuration (auto_review). | ||
| # Pre-push / finalize: run `cr --base dev` (or `coderabbit review`) from repo root; see | ||
| # https://docs.coderabbit.ai/cli/overview | ||
| # PR description: include `@coderabbitai summary` (default placeholder) for the high-level summary. | ||
| # | ||
| language: "en-US" | ||
| early_access: false | ||
| tone_instructions: >- | ||
| Provide architectural insights on system design, scalability, and long-term maintainability. | ||
| Prioritize contract-first public APIs (@icontract, @beartype), Typer/Rich CLI boundaries, OpenSpec | ||
| traceability, and cross-repo impact for bundled modules. | ||
|
|
||
| reviews: | ||
| profile: assertive | ||
| request_changes_workflow: false | ||
| high_level_summary: true | ||
| high_level_summary_in_walkthrough: true | ||
| review_details: true | ||
| sequence_diagrams: true | ||
| estimate_code_review_effort: true | ||
| assess_linked_issues: true | ||
| related_issues: true | ||
| related_prs: true | ||
| poem: false | ||
| collapse_walkthrough: true | ||
| changed_files_summary: true | ||
| review_status: true | ||
| commit_status: true | ||
| high_level_summary_instructions: | | ||
| Structure the summary for SpecFact CLI maintainers: | ||
| - User-visible behavior and CLI surface (commands, options, defaults). | ||
| - Contract/API impact: public functions, Pydantic models, module package boundaries. | ||
| - Testing and quality gates: contracts, hatch run contract-test, coverage implications. | ||
| - If applicable: OpenSpec change ID, docs/ and CHANGELOG touchpoints, module signing / version bumps. | ||
| auto_review: | ||
| enabled: true | ||
| drafts: false | ||
| auto_incremental_review: true | ||
| # PRs targeting `dev` (not only the GitHub default branch, e.g. `main`) get automatic reviews. | ||
| base_branches: | ||
| - "^dev$" | ||
| path_instructions: | ||
| - path: "src/specfact_cli/**/*.py" | ||
| instructions: | | ||
| Focus on modular CLI architecture: lazy module loading, registry/bootstrap patterns, and | ||
| dependency direction. Flag breaking changes to public APIs, Pydantic models, and resource | ||
| bundling. Verify @icontract + @beartype on public surfaces; prefer centralized logging | ||
| (get_bridge_logger) over print(). | ||
| - path: "openspec/**/*.md" | ||
| instructions: | | ||
| Treat as specification source of truth: proposal/tasks/spec deltas vs. code behavior, | ||
| CHANGE_ORDER consistency, and scenario coverage. Surface drift between OpenSpec and | ||
| implementation. | ||
| - path: "tests/**/*.py" | ||
| instructions: | | ||
| Contract-first testing: meaningful scenarios, not redundant assertions already covered by | ||
| contracts. Flag flakiness, environment coupling, and missing coverage for changed behavior. | ||
| - path: ".github/workflows/**" | ||
| instructions: | | ||
| CI safety: secrets usage, workflow dependencies, alignment with hatch test / contract-test | ||
| gates, and action versions. | ||
| - path: "scripts/**/*.py" | ||
| instructions: | | ||
| Deterministic tooling: subprocess safety, Hatch integration, and parity with documented | ||
| quality gates (format, type-check, module signing). | ||
| - path: "docs/**/*.md" | ||
| instructions: | | ||
| User-facing accuracy: CLI examples match current behavior; preserve Jekyll front matter; | ||
| call out when README/docs index need sync. | ||
|
|
||
| tools: | ||
| ruff: | ||
| enabled: true | ||
| semgrep: | ||
| enabled: true | ||
| yamllint: | ||
| enabled: true | ||
| actionlint: | ||
| enabled: true | ||
| shellcheck: | ||
| enabled: true | ||
|
|
||
| pre_merge_checks: | ||
| title: | ||
| mode: warning | ||
| requirements: "Prefer Conventional Commits-style prefixes (feat:, fix:, docs:, test:, refactor:, chore:)." | ||
| issue_assessment: | ||
| mode: warning | ||
|
|
||
| knowledge_base: | ||
| learnings: | ||
| scope: local | ||
| linked_repositories: | ||
| - repository: "nold-ai/specfact-cli-modules" | ||
| instructions: >- | ||
| Companion repo: bundled module packages (module-package.yaml), IDE prompts, and | ||
| modules.specfact.io content. When CLI surface, imports, or bundled module contracts change, | ||
| flag required updates, version bumps, and signature verification impacts. | ||
|
|
||
| chat: | ||
| auto_reply: true |
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,14 +1,23 @@ | ||
| repos: | ||
| - repo: local | ||
| hooks: | ||
| - id: specfact-code-review-gate | ||
| name: Run code review gate on staged Python files | ||
| entry: hatch run python scripts/pre_commit_code_review.py | ||
| language: system | ||
| files: \.pyi?$ | ||
| - id: verify-module-signatures | ||
| name: Verify module signatures and version bumps | ||
| entry: hatch run ./scripts/verify-modules-signature.py --require-signature --enforce-version-bump | ||
| language: system | ||
| pass_filenames: false | ||
| always_run: true | ||
| - id: check-doc-frontmatter | ||
| name: Check documentation ownership frontmatter (enforced paths) | ||
| entry: hatch run doc-frontmatter-check | ||
| language: system | ||
| files: ^(docs/.*\.md|USAGE-FAQ\.md)$ | ||
| pass_filenames: false | ||
| always_run: false | ||
| - id: specfact-code-review-gate | ||
| name: Run code review gate on staged Python files | ||
| entry: hatch run python scripts/pre_commit_code_review.py | ||
| language: system | ||
| files: \.pyi?$ | ||
| # Show summary + copy-paste lines on success; pre-commit hides hook output otherwise. | ||
| verbose: true | ||
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Paths (relative to repo root) that must carry full doc-sync frontmatter. | ||
| # Expand this list as the rollout progresses; use `scripts/check_doc_frontmatter.py --all-docs` for a full-site check. | ||
| docs/index.md | ||
| docs/getting-started/quickstart.md | ||
| docs/core-cli/init.md | ||
| docs/reference/documentation-url-contract.md | ||
| docs/contributing/docs-sync.md | ||
| docs/contributing/frontmatter-schema.md |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.