Skip to content

docs(producer): add zava-agent-config as live golden-path reference#1384

Merged
danielmeppiel merged 1 commit into
mainfrom
docs/golden-path-zava-reference
May 19, 2026
Merged

docs(producer): add zava-agent-config as live golden-path reference#1384
danielmeppiel merged 1 commit into
mainfrom
docs/golden-path-zava-reference

Conversation

@danielmeppiel
Copy link
Copy Markdown
Collaborator

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: release pipeline 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.md Monorepo-hybrid callout had a typo (zava-agent-configs plural) and no link.
  • versioning-strategies.md lockstep 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.2 tag with 15 release assets').

What

File Edit
docs/src/content/docs/producer/releasing-from-any-ci.md Add 'Reference deployment' callout after the apm-action wrapper paragraph naming zava and linking the v6.1.2 release (15 assets) + its release.yml. Note version floor (apm 0.14.0 + apm-action v1.9.1). Bump checkout@v4 -> v5 in the snippet for Node 20 deprecation alignment.
docs/src/content/docs/producer/repo-shapes.md Fix zava-agent-configs -> zava-agent-config typo + replace parenthetical with live link, noting 7 plugins under plugins/ and apm-action mode: release.
docs/src/content/docs/producer/versioning-strategies.md Append worked-example pointer to lockstep section: zava omits versioning.strategy: (default), declares one top-level version:, uses build.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):

Claim Evidence
apm-action v1.9.1 published with per-package tarball isolation gh release view v1.9.1 --repo microsoft/apm-action -> body: 'fix(release): isolate per-package tarball in shared distDir (v1.9.1)'
zava release run green on v6.1.2 gh run list --repo DevExpGbb/zava-agent-config run 26081432583 -> success
zava strategy = lockstep gh api repos/DevExpGbb/zava-agent-config/contents/apm.yml?ref=v6.1.2 -> no versioning: key, single version: 6.1.2, build.tagPattern: "v{version}" (lockstep default)
zava plugin count = 7 gh api contents/plugins?ref=v6.1.2 --jq '. | length' -> 7
zava release asset count = 15 gh release view v6.1.2 --json assets -> 7 tarballs + 7 sha256 + marketplace-6.1.2.json

Trade-offs

  • In-place edits only. No new pages, no TOC change. Keeps the polish pass scoped and reversible.
  • Single reference example. Zava is the only deployment we've end-to-end attested on apm 0.14.0 + apm-action v1.9.1. When a second producer ships at this version floor, we can fan out.
  • Lockstep section gets the worked example, not tag_pattern. Verified zava actually uses lockstep (S7 catch -- a prior draft assumed tag_pattern). The tag_pattern and per_package sections remain example-less until a real producer ships on those strategies.

How to test

  1. cd docs && npm install && npm run dev -> visit /producer/releasing-from-any-ci/, /producer/repo-shapes/, /producer/versioning-strategies/.
  2. Click every new outbound link -> confirm all resolve to live GitHub URLs (release tag, release.yml, apm.yml, plugins directory).
  3. npm run build -> Starlight build succeeds (no broken internal links).

Follow-ups (post-merge)

  • Post a follow-up comment on #1322 and #1332 linking these refreshed pages.
  • File any new producer-feedback drift here.

Co-authored-by: Copilot 223556219+Copilot@users.noreply.github.com

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>
Copilot AI review requested due to automatic review settings May 19, 2026 08:10
@danielmeppiel danielmeppiel merged commit 1155baf into main May 19, 2026
21 checks passed
@danielmeppiel danielmeppiel deleted the docs/golden-path-zava-reference branch May 19, 2026 08:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants