Document hook stage file input#2147
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. 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. 🚀 New features to boost your workflow:
|
Contributor
There was a problem hiding this comment.
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_stagesconfiguration 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. |
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
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.
Closes #2144