docs(techniques): advise inspect_session in close-out techniques (#193)#221
Merged
Conversation
…lose-out (#193) Add an advisory note to the four close-out techniques (workflow-engine verify-outcomes and generate-summary; conduct-retrospective retrospective and select-next) directing workers to read session state via the inspect_session tool rather than reading session.json directly. Signed-off-by: Mike Clay <mike.clay@shielded.io>
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.
Summary
Companion workflows-content change for issue #193. Adds an advisory note to the four close-out techniques directing workers to read session state via the new read-only
inspect_sessiontool rather than readingsession.jsondirectly.Pairs with the server-side tool in PR #215 (targets
main). This PR carries only the workflow-content half and targets theworkflowsorphan branch.Changes
meta/techniques/workflow-engine/verify-outcomes.md— adviseinspect_session(view: variables/activities/summary) for the outcome-satisfaction read.meta/techniques/workflow-engine/generate-summary.md— adviseinspect_sessionfor the activity/checkpoint/child-trace read.work-package/techniques/conduct-retrospective/retrospective.md— adviseinspect_sessionfor the retrospective's variable-bag/history read.work-package/techniques/conduct-retrospective/select-next.md— adviseinspect_sessionfor the carried-context read.Content-only advisory blockquotes; no schema or version change.
Refs #193