docs: add timing warnings to allocation payload annotation reference#316
Open
Hauke Löffler (hloeffler) wants to merge 3 commits into
Open
docs: add timing warnings to allocation payload annotation reference#316Hauke Löffler (hloeffler) wants to merge 3 commits into
Hauke Löffler (hloeffler) wants to merge 3 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds prominent timing warnings to the environment variable reference sections on the automatic registration page, so readers who land via deep anchor links still see the critical ordering constraints that affect payload/annotation behavior.
Changes:
- Adds a “Timing” warning under
ALLOC_PAYLOAD_ANNOTATIONclarifying thatAllocatedcan occur before payload annotations are written, and to wait for the “last-applied” marker. - Adds a “Timing” warning under
ALLOC_CALLBACK_PAYLOAD_ANNOTATIONclarifying callback annotations are read once atReadytime and must be present before callingReady(). - Cross-references the existing detailed sections (“Write payload to annotations” / “Return a payload to the Allocator”) for more context.
Nicholas Wiersma (nrwiersma)
approved these changes
Jun 29, 2026
…/automatically-registering-game-servers.md Co-authored-by: Christian R <[email protected]>
Christian R (antiphp)
approved these changes
Jun 29, 2026
Co-authored-by: Copilot Autofix powered by AI <[email protected]>
| @@ -301,6 +301,12 @@ Setting it to e.g. `payload-` results in the final prefix being `agones.dev/sdk- | |||
| Multi-dimensional payload results in concatenated keys using the `.` as separator. | |||
| Mutual exclusive to `ALLOC_PAYLOAD_FILE`. | |||
There was a problem hiding this comment.
Shouldn't it be Mutually exclusive with instead of to?
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
Adds timing warning boxes to the
ALLOC_PAYLOAD_ANNOTATIONandALLOC_CALLBACK_PAYLOAD_ANNOTATIONreference sections on theautomatic registration page.
Why
Readers who jump directly to the environment variable reference via
anchor links miss the timing constraints documented higher up on the
page, which can lead to unexpected behavior such as empty callback
payloads or missing annotations.
Changes
ALLOC_PAYLOAD_ANNOTATION: warns that theAllocatedstate changefires before payload annotations are written, and to wait for the
last-appliedmarker.ALLOC_CALLBACK_PAYLOAD_ANNOTATION: warns that callback annotationsare read once at
Readytime and must be confirmed on the GameServerobject before calling
Ready().Both warnings cross-reference the existing detailed sections.