Repository navigation
docs(extensions): list the converge hook events - #5328
Open
alfredoperez wants to merge 2 commits into
Open
alfredoperez wants to merge 2 commits into
alfredoperez wants to merge 2 commits into
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are identified, and the documentation-only changes do not affect runtime behavior.
No open issues 🎉
What changed in this PR
This documentation-only pull request documents the before_converge and after_converge extension hook events across the extension documentation. It does not change runtime behavior.
Changes:
- Added converge events to the project-wide hook configuration example.
- Documented converge hook points in the extension development guide.
- Added individual converge event descriptions to the API reference.
| File | Description |
|---|---|
docs/extensions/overview.md |
Lists converge events in the hook configuration example. |
docs/extensions/developing.md |
Documents converge events as available extension hook points. |
docs/extensions/api.md |
Adds detailed descriptions for both converge events. |
Review effort: Lite (auto)
mnriem
added
the
triage-can-wait
Collaborator
|
Please address test & lint errors |
Contributor
Author
|
Thanks! The only failure was |
This branch has not been deployed
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.
Description
templates/commands/converge.mdfireshooks.before_convergeandhooks.after_converge, but neither event is named anywhere in the docs. This adds them to the three places that list hook events:docs/extensions/api.md,docs/extensions/developing.mdanddocs/extensions/overview.md.Hook order is already stated consistently on main (templates surface hooks in YAML order,
HookExecutorsorts bypriority), so this PR does not touch it.Testing
Ran a script that collects every
hooks.before_*/hooks.after_*key read bytemplates/commands/*.mdand greps the docs for each. On currentmainit reported 2 events fired but undocumented (before_converge,after_converge); after this change both are documented in the three files above.Docs only; no behaviour change.
.venv/bin/specify --help(n/a, docs only)AI Disclosure
AI disclosure: drafted with Claude Code (Claude Opus 5.5, default settings); I checked every line against main.