docs: add Prerequisites section to BUNDLE_GUIDE.md - #294
Open
Brian Krabach (bkrabach) wants to merge 1 commit into
Open
docs: add Prerequisites section to BUNDLE_GUIDE.md#294Brian Krabach (bkrabach) wants to merge 1 commit into
Brian Krabach (bkrabach) wants to merge 1 commit into
Conversation
Documents a convention that is followed in practice but absent from
the spec. amplifier-bundle-digital-twin-universe and
amplifier-bundle-gitea both carry the verbatim heading/sentence
'## Prerequisites Check' / 'If prerequisites are missing, report
clearly and stop. Do not attempt workarounds.' in their SKILL.md
files. A closely related agent-level variant ('## Prerequisites
Self-Check (REQUIRED)') appears in amplifier-bundle-amplifier-tester
and amplifier-bundle-browser-tester. BUNDLE_GUIDE.md itself has zero
matches for prerequisite/post-install/install hook/system dep.
The bundle format has no post-install hook ('amplifier bundle add'
takes only a URI, --name, --app), so prerequisite checking has to
live in skill/agent/module bodies. This section documents the
userspace-vs-privileged-install boundary observed in practice, and
flags amplifier-bundle-browser-tester's ungated 'agent-browser
install --with-deps' as a known divergence rather than a second
sanctioned convention.
Generated with [Amplifier](https://github.com/microsoft/amplifier)
Co-Authored-By: Amplifier <240397093+microsoft-amplifier@users.noreply.github.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.
Summary
docs/BUNDLE_GUIDE.md, documenting a convention that is followed in practice but currently absent from the spec.amplifier-bundle-browser-tester's ungatedagent-browser install --with-depsas a known divergence, not a second sanctioned convention.Evidence (verified independently against each repo, not taken on the request as-is)
amplifier-bundle-digital-twin-universeandamplifier-bundle-giteaboth carry the verbatim heading## Prerequisites Checkand sentence "If prerequisites are missing, report clearly and stop. Do not attempt workarounds." inskills/<name>/SKILL.md— confirmed.docs/BUNDLE_GUIDE.mdhas zero matches forprerequisit|post-install|install hook|system dep(case-insensitive) prior to this change — confirmed.amplifier-bundle-browser-testerself-installsagent-browservianpm install -g agent-browser, and on Linux also runsagent-browser install --with-deps(system packages) as a normal, ungated setup step in itsbundle.md/README.md/context/browser-awareness.md— confirmed.amplifier bundle add(checked via--helpagainst the installed CLI) takes onlyURI,--name,--app— no post-install hook exists in the format — confirmed.amplifier-bundle-amplifier-testerdoes not carry the identical## Prerequisites Checkheading/sentence found in the other two. Its match (agents/setup-digital-twin.md) uses a different heading,## Prerequisites Self-Check (REQUIRED), and slightly different wording, "If any prerequisite is missing..." — the same variant used byamplifier-bundle-browser-tester's agent files, not thedigital-twin-universe/giteaSKILL.md wording. The PR documents both the verbatim SKILL.md-level convention and this agent-level variant rather than asserting three-way verbatim identity.Test plan
BUNDLE_GUIDE.mdfor the relevant termsamplifier bundle add --helphas no post-install hook optionGenerated with Amplifier