Skip to content

Document hook stage file input#2147

Merged
j178 merged 1 commit into
masterfrom
docs-stages
Jun 4, 2026
Merged

Document hook stage file input#2147
j178 merged 1 commit into
masterfrom
docs-stages

Conversation

@j178
Copy link
Copy Markdown
Owner

@j178 j178 commented Jun 4, 2026

Closes #2144

Copilot AI review requested due to automatic review settings June 4, 2026 06:55
@j178 j178 added the documentation Improvements or additions to documentation label Jun 4, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Jun 4, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.52%. Comparing base (0fa2929) to head (af1a523).
⚠️ Report is 1 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2147   +/-   ##
=======================================
  Coverage   92.51%   92.52%           
=======================================
  Files         122      122           
  Lines       26016    26016           
=======================================
+ Hits        24070    24071    +1     
+ Misses       1946     1945    -1     

☔ 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the documentation to clearly define what input (repository file paths vs. no files vs. message file) each supported Git hook stage receives, so users understand when file filters (files, types, etc.) apply and when always_run: true is required.

Changes:

  • Adds a “Supported Git Hook Stages” reference section describing stage semantics and hook input.
  • Cross-links the stages / default_stages configuration docs to that stage semantics section.
  • Updates hook authoring docs to point hook authors to the stage semantics reference.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
docs/reference/configuration.md Adds a stage semantics table and links from stages/default_stages to clarify hook input and filtering behavior.
docs/authoring-hooks.md Links hook authors to the stage semantics reference for correct stage selection and expectations.

@j178 j178 merged commit da457c5 into master Jun 4, 2026
33 checks passed
@j178 j178 deleted the docs-stages branch June 4, 2026 06:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

prek fails to run hooks with file filters for the post-merge hook

2 participants