docs(readme): document setup apply events interface - #569
Merged
Merged
Conversation
Document the additive setup.sh apply --events DIR interface and add an integrator note covering event directories and automation constraints. Refs: z-shell/src#225
Clarify in the integrator note that consumers must treat process completion as authoritative and tolerate a missing terminal event when cancellation interrupts publication. Note that staging cleanup and exit code 6 still apply. Refs: z-shell/src#225
This was referenced Sep 20, 2026
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
1 participant
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
Update README.md to document the additive
setup.sh apply --events DIRinterface from z-shell/src#225. Adds an integrator note explaining that--events DIRis optional, creates a private new absolute directory, publishes atomic numberedzi-setup-event-v1event directories with started and terminal state, and notes that human stdout/stderr must not drive automation.Related issues
Refs: z-shell/src#225