fix(unit-only): Write docs/harness.md on main, porting/adapting git show ... (#1580)#57
Draft
aidandaly24 wants to merge 1 commit into
Draft
fix(unit-only): Write docs/harness.md on main, porting/adapting git show ... (#1580)#57aidandaly24 wants to merge 1 commit into
aidandaly24 wants to merge 1 commit into
Conversation
Coverage Report
|
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.
Refs aws#1580
Issues
latestbuild, so only preview-channel users hit the documentation gap, and the README plus the vended AGENTS.md asset already cover the essentials.Root cause
docs/harness.md absent at HEAD v0.20.2 (verified ls-tree/ls empty). README.md:170-189 (from aws#1577, an ancestor of HEAD) documents the preview-gated harness surface + EXPORT_NOTES.md but links no guide; no broken link (README:326 -> docs/tui-harness.md, which exists). The 263-line preview doc (commit 1a1de9b) is NOT an ancestor of HEAD (merge-base --is-ancestor false). Feature is implemented but preview-gated: harnessPrimitive undefined unless isPreviewEnabled() (registry.ts:26); export/add tool/add skill register only under isPreviewEnabled() (cli.ts:126-141); PREVIEW baked via BUILD_PREVIEW (esbuild.config.mjs:56), set only on the @Preview publish, so harness commands are dark in v0.20.2 latest. No commit/PR references aws#1580.
The fix
Write docs/harness.md on main, porting/adapting git show 1a1de9b:docs/harness.md. Reconcile command surface: foreground
add harness/add tool --harness/add skill --harness/export harnessper README:183-186; scope or drop the preview doc'sagentcore create --name myharnessharness-project flow to match what the main-line CLI registers. Cover the declarative config model, the export->Strands app/ workflow, and the mandatory EXPORT_NOTES.md follow-up (README:188; AGENTS.md:138-146). Mark the doc preview-only to mirror README:170[preview]. Optionally link into the README docs index near line 326.Files touched: New file: /local/home/aidandal/workplace/issues/agentcore-cli/docs/harness.md. Reference sources at HEAD: README.md:170-189; src/cli/commands/export/harness-action.ts:187-206,297-336; src/cli/commands/export/index.ts:17; src/cli/commands/export/constants.ts:1; src/cli/primitives/HarnessPrimitive.ts (registerCommands at :647); src/cli/primitives/registry.ts:26; src/cli/cli.ts:125-141; src/assets/agents/AGENTS.md:138-146. Prior art to port: docs/harness.md at git commit 1a1de9b (preview branch only).
Validation evidence
The fix was verified by reproducing the original symptom and re-running after the change:
AFTER (branch fix/1580): docs/harness.md exists (151 lines) + README docs index gains exactly one line "- Harness" (git diff README.md = 1 insertion, surgical). Pass conditions verified:
(1) Config model section at line 24 (runtime+model, memory --memory-mode managed/existing/--memory-name/--memory-arn, execution limits, --network-mode PUBLIC|VPC, observability); Export->Strands app// workflow section at line 94; dedicated "Read EXPORT_NOTES.md before you deploy" section at line 123 with the mandatory follow-up guidance.
(2) Command-surface table documents ONLY add harness / add tool --harness / add skill --harness / export harness (+ remove harness). All four verified REGISTERED at HEAD via the built CLI:
node dist/cli/index.mjs add harness|add tool|add skill|export harness --helpall exit 0. Tool types in doc (agentcore_browser, agentcore_code_interpreter, remote_mcp, agentcore_gateway, inline_function) match tool-action.ts. EXPORT_NOTES.md path app// matches harness-action.ts:336.(3) Forbidden grep all ABSENT: 'create --name myharness', '--no-har
Test suite: green.
Staged on the fork as a draft for human review. Promote to aws/agentcore-cli after vetting.