Skip to content

docs(pre-commit): publish supported hook design - #748

Merged
Jamie-BitFlight merged 5 commits into
mainfrom
docs/pre-commit-provider-design
Oct 13, 2026
Merged

Jamie-BitFlight merged 5 commits into
mainfrom
docs/pre-commit-provider-design

Conversation

@Jamie-BitFlight

Copy link
Copy Markdown
Contributor

Why

#745 intentionally shipped the provider before changing the consumer README because the existing v2 tag did not yet contain the hook. Release 2.1.0 is now published, so the public guidance can be corrected.

This also fixes a deeper pre-commit design issue: a moving major tag is not a reliable rev. pre-commit caches hook repositories by repository + revision string, so an existing rev: v2 cache is not guaranteed to refresh when that tag moves.

Changes

  • Replace the README's old repo: local workaround with the published hook.
  • Document an immutable rev: v2.1.0 and pre-commit autoupdate for upgrades.
  • Clarify that action and README paths are configurable while the config file remains .ghadocs.json.
  • Add the durable provider design to docs/tool-contract.md: consumer Node/npm runtime, exact npm-version binding, argument forwarding, no staged filenames, and immutable release refs.
  • Route published pre-commit work correctly from AGENTS.md instead of treating all Git-hook work as Husky.
  • Extend the integration smoke test to execute the exact documented release tag in addition to the PR-head provider.

Verification target

The existing PR-head smoke must still prove argument forwarding, mutation detection, and idempotence. The added release smoke must prove that the copy/paste v2.1.0 configuration resolves and updates the configured README while leaving the default README alone.

Copy link
Copy Markdown
Contributor Author

@codex review

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 13, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-13T11:40:56.184302Z c5ab23f Manual request
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai

coderabbitai Bot commented Oct 13, 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 4 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
  • Configuration used: Repository: bitflight-devops/github-action-readme-generator/.coderabbit.yaml
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: c55635f8-306f-48d3-903d-901afe983526
📥 Commits

Reviewing files that changed from the base of the PR and between b0624fe and c5ab23f.

📒 Files selected for processing (4)
  • .github/workflows/integration-test.yml
  • AGENTS.md
  • README.md
  • docs/tool-contract.md
  • 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.

Copy link
Copy Markdown
Contributor Author

@codex review

@github-actions

github-actions Bot commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Coverage Report

Status Category Percentage Covered / Total
🔵 Lines 94.05% 1012 / 1076
🔵 Statements 94.18% 1037 / 1101
🔵 Functions 96.95% 159 / 164
🔵 Branches 88.26% 564 / 639
File CoverageNo changed files found.
Generated in workflow #1157 for commit c5ab23f by the Vitest Coverage Report Action

@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review: Didn't find any major issues. More of your lovely PRs please.

Reviewed commit: c5ab23f5c4

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

@Jamie-BitFlight
Jamie-BitFlight merged commit 12511b6 into main Oct 13, 2026
12 checks passed
@Jamie-BitFlight
Jamie-BitFlight deleted the docs/pre-commit-provider-design branch October 13, 2026 11:41
@Jamie-BitFlight

Copy link
Copy Markdown
Contributor Author

🎉 This PR is included in version 2.1.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@Jamie-BitFlight Jamie-BitFlight added the released This issue/pull request has been released. label Oct 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

released This issue/pull request has been released.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant