docs(custom-handler): clarify IsInstalled call sites and authoring guidance (#750) - #896
Merged
Merged
Conversation
…idance (#750) The how-to-implement-custom-update-handler.md table row for IsInstalled previously said 'In some situation' without listing them, leading to issue #750. Rewrite the IsInstalled row to describe the contract (cheap, side-effect-free, idempotent; handler-scoped state; installedCriteria) and add an 'IsInstalled call sites and authoring guidance' section enumerating where the agent core and Steps Handler invoke it, the authoring rules, and the conjunction semantics for multi-step manifests. Fixes #750
chgennar
approved these changes
Jun 23, 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
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.
Summary
Resolves #750. The
IsInstalledrow indocs/agent-reference/how-to-implement-custom-update-handler.mdpreviously said only "In some situation, an Agent workflow can invoke 'IsInstalled'…" without explaining which situations, which is exactly what the issue reported.Changes
docs/agent-reference/how-to-implement-custom-update-handler.md:Rewrote the
IsInstalledtable row to state the actual contract: it is a probe that may be called multiple times per deployment and must be cheap, side-effect-free, and idempotent; it compares the workflow'sinstalledCriteriaagainst handler-scoped state and must not consult system-wide state. Also fixed a malformed<br/and clarified that aResultCodeof0isADUC_Result_Failure(which the Steps Handler treats asNotInstalled).Added an "IsInstalled call sites and authoring guidance" section that:
Downloadand beforeInstall/Apply; and the aggregate call after the per-(component × step) loop);installedCriteria, don't return0to mean "installed", no reboots/restarts);Documentation-only change (+24 / −1); no code is affected.
Fixes #750