docs(producer): add zava-agent-config as live golden-path reference#1384
Merged
Conversation
Strengthen the producer docs by pointing readers to the live attested
deployment (DevExpGbb/zava-agent-config @ v6.1.2) that exercises the
canonical apm pack + apm-action mode: release pipeline end-to-end.
- releasing-from-any-ci.md: add 'Reference deployment' callout naming
zava and linking the v6.1.2 release (15 assets: 7 tarballs +
7 sha256 + marketplace-6.1.2.json) and its release.yml workflow.
Bump checkout@v4 to v5 for Node 20 deprecation alignment.
- repo-shapes.md: fix typo 'zava-agent-configs' -> 'zava-agent-config'
in the Monorepo-hybrid callout and replace the parenthetical with a
live link to the example.
- versioning-strategies.md: append worked-example pointer to the
lockstep section, citing zava's apm.yml (default strategy, single
top-level version, build.tagPattern: 'v{version}').
All claims verified against live sources (apm 0.14.0 --help, gh release
view v6.1.2, gh api contents/plugins?ref=v6.1.2). Discussions
#1322 and #1332 will receive follow-up
comments linking these pages once merged.
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This docs-only PR updates producer guidance to point readers at DevExpGbb/zava-agent-config as a live reference for the lockstep monorepo release path.
Changes:
- Adds a reference deployment callout to the release pipeline docs and updates the checkout action snippet.
- Links the zava monorepo from repo-shape guidance.
- Adds zava as a worked lockstep versioning example.
Show a summary per file
| File | Description |
|---|---|
docs/src/content/docs/producer/releasing-from-any-ci.md |
Updates the GitHub Actions snippet and adds a reference deployment callout. |
docs/src/content/docs/producer/repo-shapes.md |
Replaces the previous zava mention with a live reference link and release details. |
docs/src/content/docs/producer/versioning-strategies.md |
Adds a worked lockstep example using the zava repo. |
Copilot's findings
- Files reviewed: 3/3 changed files
- Comments generated: 1
| > attaches 7 per-plugin tarballs + their `.sha256` companions + | ||
| > `marketplace-6.1.2.json` (15 assets total) via the workflow in | ||
| > [`.github/workflows/release.yml`](https://github.com/DevExpGbb/zava-agent-config/blob/main/.github/workflows/release.yml). | ||
| > Apm `0.14.0` and apm-action `v1.9.1` or newer required. |
sergio-sisternes-epam
pushed a commit
that referenced
this pull request
May 19, 2026
…1384) Strengthen the producer docs by pointing readers to the live attested deployment (DevExpGbb/zava-agent-config @ v6.1.2) that exercises the canonical apm pack + apm-action mode: release pipeline end-to-end. - releasing-from-any-ci.md: add 'Reference deployment' callout naming zava and linking the v6.1.2 release (15 assets: 7 tarballs + 7 sha256 + marketplace-6.1.2.json) and its release.yml workflow. Bump checkout@v4 to v5 for Node 20 deprecation alignment. - repo-shapes.md: fix typo 'zava-agent-configs' -> 'zava-agent-config' in the Monorepo-hybrid callout and replace the parenthetical with a live link to the example. - versioning-strategies.md: append worked-example pointer to the lockstep section, citing zava's apm.yml (default strategy, single top-level version, build.tagPattern: 'v{version}'). All claims verified against live sources (apm 0.14.0 --help, gh release view v6.1.2, gh api contents/plugins?ref=v6.1.2). Discussions #1322 and #1332 will receive follow-up comments linking these pages once merged. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This was referenced May 20, 2026
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.
TL;DR
Polish pass on the producer docs corpus to point cold readers at the live attested deployment (DevExpGbb/zava-agent-config @ v6.1.2) that exercises the canonical
apm pack+apm-action mode: releasepipeline end-to-end. Three in-place edits, no TOC or schema changes.Why
Two open discussions (#1322 monorepo layout, #1332 versioning strategies) asked for guidance that we have already shipped and attested, but the docs corpus did not direct readers to the live example:
releasing-from-any-ci.md(strongest producer page) had no reference deployment link.repo-shapes.mdMonorepo-hybrid callout had a typo (zava-agent-configsplural) and no link.versioning-strategies.mdlockstep section had no worked example.Result: producers reading the docs cold could not trace from concept ('hybrid monorepo with lockstep') to evidence ('here are 7 plugins shipping today on a single
v6.1.2tag with 15 release assets').What
docs/src/content/docs/producer/releasing-from-any-ci.mdrelease.yml. Note version floor (apm 0.14.0 + apm-action v1.9.1). Bumpcheckout@v4 -> v5in the snippet for Node 20 deprecation alignment.docs/src/content/docs/producer/repo-shapes.mdzava-agent-configs->zava-agent-configtypo + replace parenthetical with live link, noting 7 plugins underplugins/and apm-actionmode: release.docs/src/content/docs/producer/versioning-strategies.mdversioning.strategy:(default), declares one top-levelversion:, usesbuild.tagPattern: "v{version}"for a single repo-wide tag.How (verification)
Every code-truth claim verified with real commands before drafting (S7 deterministic tool bridge per the docs-sync skill):
gh release view v1.9.1 --repo microsoft/apm-action-> body: 'fix(release): isolate per-package tarball in shared distDir (v1.9.1)'gh run list --repo DevExpGbb/zava-agent-configrun 26081432583 ->successgh api repos/DevExpGbb/zava-agent-config/contents/apm.yml?ref=v6.1.2-> noversioning:key, singleversion: 6.1.2,build.tagPattern: "v{version}"(lockstep default)gh api contents/plugins?ref=v6.1.2 --jq '. | length'-> 7gh release view v6.1.2 --json assets-> 7 tarballs + 7 sha256 + marketplace-6.1.2.jsonTrade-offs
How to test
cd docs && npm install && npm run dev-> visit/producer/releasing-from-any-ci/,/producer/repo-shapes/,/producer/versioning-strategies/.npm run build-> Starlight build succeeds (no broken internal links).Follow-ups (post-merge)
Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com