Skip to content

A generated docs/workflow.md maps each caller to the bundled rules that fire there - #418

Merged
HackingGate merged 1 commit into
mainfrom
workflow-doc
Oct 23, 2026
Merged

HackingGate merged 1 commit into
mainfrom
workflow-doc

Conversation

@HackingGate

Copy link
Copy Markdown
Owner

Adds docs/workflow.md, a caller map: a Mermaid flowchart from each entry point (git commit and push hooks, shimmed commands, agent tool calls, CI and manual) to the uphold command it ends in, then one table per caller of the bundled rules that fire there (rule id, set, first sentence of the message).

tests/workflow_doc.rs renders it and fails while the committed file differs; UPHOLD_WORKFLOW_GOLDEN=bless cargo test --test workflow_doc rewrites it. The tables come from rules --sets --json (ids, sets, messages) and rules --effective --json over a scratch repository inheriting every set (where each rule runs, as the engine's Rule::seams answers). The diagram and surrounding prose are constants in the test.

The brief said uphold hooks --install covers lefthook or prek; the code refuses lefthook, which owns its hooks (written by uphold init --lefthook). The page says so.

https://claude.ai/code/session_01YTpdnDJrf2hT6hFyjS7evA

@coderabbitai

coderabbitai Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 32 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 1a0b8634-6e8a-4cc5-8c6f-5f0437ba215e
📥 Commits

Reviewing files that changed from the base of the PR and between d84013c and 0a1ecf1.

📒 Files selected for processing: 3
  • README.md
  • docs/workflow.md
  • tests/workflow_doc.rs
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov-commenter

codecov-commenter commented Oct 23, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.85%. Comparing base (d84013c) to head (0a1ecf1).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #418   +/-   ##
=======================================
  Coverage   94.85%   94.85%           
=======================================
  Files          52       52           
  Lines       27259    27259           
=======================================
  Hits        25857    25857           
  Misses       1402     1402           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

HackingGate added a commit that referenced this pull request Oct 23, 2026
…rrent passes again (#419)

Upstream tagged v0.17.2 while #417 and #418 were in CI, and the manual-stage
pin check failed both on a line neither touched. ruff check and ruff format
under v0.17.2 report nothing new over the whole tree.

Claude-Session: https://claude.ai/code/session_01YTpdnDJrf2hT6hFyjS7evA
…o the command it ends in, and lists the bundled rules that fire at each caller

tests/workflow_doc.rs renders the page from the binary's own `rules --sets --json` and `rules --effective --json` and fails while the committed file differs; UPHOLD_WORKFLOW_GOLDEN=bless rewrites it. README.md links it.

Claude-Session: https://claude.ai/code/session_01YTpdnDJrf2hT6hFyjS7evA
@HackingGate
HackingGate merged commit 818cd57 into main Oct 23, 2026
12 checks passed
@HackingGate
HackingGate deleted the workflow-doc branch October 23, 2026 13:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants