docs: reflect Foundry's :2 first-publish version in prompt-agent quickstart#189
Merged
Merged
Conversation
…ent.json field names The prompt-agent quickstart tutorial assumed Foundry assigns version :1 when you save+publish a prompt agent for the first time in the portal. In practice, Foundry numbers the unpublished draft :1 and assigns :2 on first publish, so the seed pointer in agentops.yaml should be travel-agent:2, not :1. Also correct the example foundry-agent.json: the artifact written by prompt_deploy uses flat field names (source_agent, candidate_agent, prompt_sha256, git_sha, workflow_url), not the nested agentops.* shape the tutorial previously showed. Add a callout explaining the SDK vs. portal numbering asymmetry: because CI uses the SDK and starts at :1 in an empty project, the bootstrap may fire on the first one or two deploys per environment before the env catches up to the seed value. After that, normal reuse/create flow takes over. This is fine because prompt_sha256 + git_sha are the durable cross-environment identity, not the per- project version numbers. Co-authored-by: Copilot <223556219+Copilot@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.
Fixes a couple of accuracy bugs in the prompt-agent quickstart tutorial that surfaced during a real run-through.
What was wrong
agentops.yaml, the wizard prompt, and the playground walkthrough were all off by one.foundry-agent.jsonhad the wrong field names. The tutorial showedagent_source/agent_candidateand a nestedagentops.*block.pipeline/prompt_deploy.pyactually writes flatsource_agent/candidate_agent/prompt_sha256/git_sha/workflow_url. Anyone copying the example to script against would break.What changed
travel-agent:1totravel-agent:2: prereqs row, mental-model diagram, journey table,microsoft-foundryskill prompt (Path B), section 4 header + Save callout, section 5 playground, section 7 init wizard, section 9agentops.yamlexample, and the section 11 PR-workflow narrative.foundry-agent.jsonrewritten to match what the deploy artifact actually contains today (flat field names, full set of identifiers).:1in an empty project, the bootstrap may fire on the first one or two deploys per environment before the env catches up to the sandbox seed (:2). After that, normal reuse/create flow takes over. The durable identity isprompt_sha256+git_sha, not the per-project version numbers — the existing mental-model section already says this; the new callout just makes the practical consequence explicit so readers don't think CI is misbehaving when they seeaction: bootstrappedtwice in a row.Success criteriaandWhere to go nextblocks updated to drop staletravel-agent:1claims about the dev seed.Validation
python -m pytest tests/unit/test_prompt_deploy.py -x -q→ 7 passed.docs/tutorial-end-to-end.md— already saystravel-agent:2after first publish (line 181). No change needed there.docs/tutorial-hosted-agent-quickstart.mddoes not mention prompt-agent version numbers — no change needed.Out of scope
prompt_deployalready handles the bootstrap-fires-twice case correctly; the only ask was that the tutorial stop misrepresenting what the user will observe.