Repository navigation
docs: flow 2.2.0 reference (hold until 2.2.0 is released) - #269
Merged
Merged
Conversation
… versions connect-an-agent said no tool approves a save without saying what does. It now names the released route (openadapt flow item-approval) and the three approval tools on main. Desktop pages described a per-save approval form that desktop-v0.15.0 doesn't have. data-handling gains a by-command table of what leaves the computer, including the countersign timestamp request on main. configuration listed OPENADAPT_FLOW_BROWSER, which isn't in openadapt-flow 2.1.0.
item-approval approve refuses an answer with neither --approver-id nor --unauthenticated, so the example would have failed.
# Conflicts: # docs/security/data-handling.md
…signing, configuration, verify.yaml Write the reference for what ships in openadapt-flow 2.2.0 and openadapt-agent 2.2.1, and pin the generated command help to OpenAdapt main until those versions are on PyPI.
Follow main's Flow reference (#265) for Flow: FLOW_VERSION 2.2.0, built from OpenAdapt main until the release is on PyPI. The launcher and agent help stay with generate_cli_reference.py.
# Conflicts: # docs/how-to/connect-an-agent.md # docs/reference/configuration.md # docs/security/data-handling.md
Release day for #269: pins openadapt-flow==2.2.0 and openadapt-agent==2.2.1, snapshots the Flow command reference from the PyPI release, regenerates the launcher and agent help, and lists the six verbs 2.2.0 added in the curated table. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Keeps the released 2.2.0 pins with main's click pin, and the release-only version list in the generated help header. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.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.
Hold this PR. Don't merge it until openadapt-flow 2.2.0 is on PyPI. It goes live the day 2.2.0 is released.
This PR documents what ships in openadapt-flow 2.2.0 and openadapt-agent 2.2.1. That is OpenAdapt
mainplus the version bump in OpenAdaptAI/OpenAdapt#1209. Until the release, the pages describe behavior that's onmainbut not yet installable from PyPI.It's stacked on #267, the launcher and agent help drift check. #266 is merged and is already included. Once #267 merges, change the base to
main.What it adds
serveoption.candidates, the separate-session read, checks shown by demonstration, the on-screen read-back, and plugin verifiers.VERIFIEDeligibility, certification, and Seal check level. A marked spot is left for the R0–R3 ladder, which will be filled in when the reopen-readback change lands.verify-runeffect receipts, andcountersign: timestamps, the TSA choice, commitments, the vault, the exception queue, and the dossier. The receipt and Seal sections in the files page and the Execute page now link here instead of repeating it.onscreenand plugin effects,candidates,identity:,idempotency:,require_settled,layout_drift_check, the remote-decision fields, and the 2.2.0 environment variables.verify.yamlreference and the one-commandqualifycampaign.check,countersign,jit,pull,triage, andverify-run.mainonly" notes for features that ship in 2.2.0: agent recording, countersign disclosure, package folding, and the browser choice.Command help pins
The pins point at OpenAdapt
mainat 9104577e and label it as the 2.2.0 and 2.2.1 releases:scripts/flow_cli_reference.py(ci(docs): command reference from the released Flow; private name check #265) hasFLOW_VERSION = "2.2.0", plus aFLOW_SOURCEthat builds from that commit until 2.2.0 is on PyPI. Theflow-cli-releasejob compares the snapshot against that build. The 2.2.0 snapshot has the same commands and options as the build the docs were written against.cli-reference/requirements.txthas source pins in the formname @ git+URL # release VERSION. The installed-version check skips those pins.Not documented yet
The approvals pages describe
mainas it is now: every run waits on each save unless the operator picks another mode. The decided plan is to admit once, then stop only on problems, with per-save approval as the strictest setting. It lands in OpenAdaptAI/OpenAdapt#1212 and isn't described here. If #1212 merges before 2.2.0, the approvals section, the mode table, and the FAQ answer need updating before this merges.These open PRs aren't documented either: OpenAdaptAI/OpenAdapt#1231 (surface rule), #1233 (
record --verify), #1235 (SMART auth), and #1239 (the read-back ladder). The verification page leaves a marked spot for the ladder.On release day
FLOW_SOURCE = Noneand rerunflow_cli_reference.py snapshot. Change the two source pins toopenadapt-flow==2.2.0andopenadapt-agent==2.2.1, then rerunscripts/generate_cli_reference.py. Fix any page the diff touches. #1209 has to mergemainbefore the release, and the help text from docs: fix approval-mode default, agent approval tools, and launcher serve help OpenAdapt#1238 will show up here too.openadapt-flowno longer depends onopenadapt-types, andopenadapt-agentdepends onopenadapt-flow.