Skip to content

Commit 8032d9f

Browse files
placerdaCopilot
andauthored
docs: correct skill verification claim to PR workflow only (#211)
The skip-if-skill callout in step 13 of the prompt-agent tutorial claimed the workflow skill triggered a first verification run of both agentops-pr.yml AND agentops-deploy-dev.yml. That over-claims: - agentops-pr.yml triggers on pull_request or workflow_dispatch. The skill dispatches it as a sanity check, which is the verification run step 13 expects users to see in the Actions tab. - agentops-deploy-dev.yml triggers on push to develop (or workflow_dispatch). The skill does not dispatch it. The first real run happens at the end of the section, after the user merges the baseline PR into the trunk branch. The callout now mentions only agentops-pr.yml and explicitly tells the reader that the deploy-dev run will fire later, on the merge. Also moves the PR #210 changelog entry from [0.3.1] (already released) to [Unreleased] where it belongs, and folds the correction into the same entry. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 92e840e commit 8032d9f

2 files changed

Lines changed: 26 additions & 18 deletions

File tree

CHANGELOG.md

Lines changed: 17 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,31 @@ This format follows [Keep a Changelog](https://keepachangelog.com/) and adheres
55

66
## [Unreleased]
77

8-
## [0.3.1] - 2026-05-29
9-
108
### Changed
11-
- **Tutorials: state directly that the workflow skill already wired the first run.**
9+
- **Tutorials: skip-if-skill callouts now state the skill's outcome directly and accurately.**
1210
The `step 13` callout in `docs/tutorial-prompt-agent-quickstart.md` and the
1311
baseline-run paragraph in `docs/tutorial-end-to-end.md` previously opened
1412
with "if you used the workflow skill, this is already done…" plus a
1513
manual-fallback block. That conditional framing was confusing because the
1614
preceding step (`step 12` of the prompt-agent tutorial, `step 5` of the
1715
end-to-end tutorial) only documents the workflow-skill path — there is no
1816
alternative wired-by-hand path the reader could have taken. Both callouts
19-
now state the skill's outcome directly ("the workflow skill already
20-
committed your changes, pushed `main`, and triggered a first verification
21-
run of …"), and the redundant `git add` / `commit` / `push` and
22-
`gh workflow run agentops-pr.yml --ref main` blocks have been removed (the
23-
skill already triggers the first run). A small `gh run list` /
24-
`gh run watch` snippet remains as an opt-in way to wait on the run from
25-
the terminal instead of the Actions UI.
17+
now state the skill's outcome directly, and the redundant `git add` /
18+
`commit` / `push` and `gh workflow run agentops-pr.yml --ref main` blocks
19+
have been removed (the skill already triggers the first run). A small
20+
`gh run list` / `gh run watch` snippet remains as an opt-in way to wait
21+
on the run from the terminal instead of the Actions UI. The previous
22+
wording also over-claimed that the skill triggered verification runs of
23+
**both** `agentops-pr.yml` and `agentops-deploy-dev.yml`; the skill only
24+
dispatches the PR workflow as a sanity check (`workflow_dispatch`), while
25+
`agentops-deploy-dev.yml` triggers on the first real merge into the trunk
26+
branch. The callout now reflects this accurately and notes that the
27+
deploy-dev run happens at the end of the section, not during the skill's
28+
setup.
29+
30+
## [0.3.1] - 2026-05-29
31+
32+
### Changed
2633
- **Tutorials now flag the workflow skill's setup actions as redundant in the manual follow-up steps.**
2734
When users run the `agentops-workflow` skill in the CI-wiring step of either
2835
the prompt-agent tutorial (step 12) or the end-to-end tutorial (step 5, the

docs/tutorial-prompt-agent-quickstart.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -763,16 +763,17 @@ have something to compare against.
763763

764764
The workflow skill in step 12 already committed your local changes,
765765
pushed `main` to the GitHub remote, and triggered a first verification
766-
run of both `agentops-pr.yml` and `agentops-deploy-dev.yml` as part of
767-
its end-to-end setup. Open the repo's **Actions** tab and confirm both
768-
runs are green:
766+
run of `agentops-pr.yml` (via `workflow_dispatch`) as part of its
767+
end-to-end setup. Open the repo's **Actions** tab and confirm both the
768+
`Stage Foundry prompt candidate (PR)` and `AgentOps eval (PR gate)`
769+
jobs of that run are green.
769770

770-
- `agentops-pr.yml` — both `Stage Foundry prompt candidate (PR)` and
771-
`AgentOps eval (PR gate)` jobs are green.
772-
- `agentops-deploy-dev.yml` — has a matching run that also went green.
771+
`agentops-deploy-dev.yml` does not run yet — it triggers on a real
772+
merge into your trunk branch (or on `workflow_dispatch`), and the first
773+
merge happens at the end of this section.
773774

774-
If you want to wait on the first PR run from the terminal instead of
775-
the Actions UI:
775+
If you want to wait on the first PR-workflow verification run from the
776+
terminal instead of the Actions UI:
776777

777778
```powershell
778779
$runId = gh run list --workflow agentops-pr.yml --branch main --limit 1 --json databaseId --jq '.[0].databaseId'

0 commit comments

Comments
 (0)