docs: document the concurrency model, convergence guarantees, and non-goals - #541
Merged
Merged
Conversation
…-goals Add a concurrency-and-convergence explanation to the internals architecture page: per-component concurrency-group isolation, the optimistic read-modify-write with re-apply that all finalize paths use, the bounded jittered retry and its convergence markers, why merge_group on the side-effecting orchestrate lane is rejected in favor of merge_queue.enabled, and how extra_paths and shared_paths thread a shared change to the components that consume it. State the deliberate non-goals: no intra-repo component ordering, no per-component state files, no same-component cross-lane serialization. Codify in CONTRIBUTING that a breaking generator or validation change must scan and migrate the fleet example repos in the same change, since the fleet repin regenerates every example repo with the release-candidate binary before any suite runs. Signed-off-by: Joshua Temple <joshua.temple@stablekernel.com>
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.
What
Documents the concurrency behavior shipped in this campaign, and states the deliberate non-goals so users are not surprised.
cascade-state-writeconvergence markers; whyextra_triggers.merge_groupon the side-effecting orchestrate lane is rejected in favor ofmerge_queue.enabled; and howextra_paths/shared_pathsthread a shared change to its consumers.Verification
Docs site builds (26 pages).
go buildandgo test ./...green. Content verified against the shipped behavior; single-sourced with links. Docs + CONTRIBUTING only, no product code.