ci: trigger the docs reference regeneration on release - #2900
Closed
Rachael-Graham wants to merge 1 commit into
Closed
Rachael-Graham wants to merge 1 commit into
Rachael-Graham wants to merge 1 commit into
Conversation
kagent-dev/website regenerates the kagent reference docs -- the CRD API reference, the Helm values reference, the CLI pages and the version conrefs. It used to do that nightly from kagent main, which meant the 1.x docs described code no released kagent contained while the install commands on the same pages named an older release. It now builds from a release tag instead, so it needs to know when a release happened. `on: release` cannot fire in website for a release published here, so kagent has to tell it. This adds a job that dispatches a kagent-release event carrying the version. It runs after `release` on purpose: the docs workflow looks the release up by tag and resolves the runtime image digests from GHCR, so both the release and the images have to exist before it starts. It is also continue-on-error, because a missed docs ping is recoverable by dispatching that workflow by hand and is not worth failing a release over. The version is sent explicitly rather than letting the docs workflow fall back to "latest release", so re-running an older tag regenerates that release instead of whatever is newest. Requires two secrets that do not exist yet, which is why this is a draft: APP_ID and APP_PRIVATE_KEY for a GitHub App installed on kagent-dev/website with Contents: write. GITHUB_TOKEN is scoped to this repository and cannot dispatch across repos. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Signed-off-by: Rachael Graham <rachael.graham@solo.io>
Author
|
Closing: we're going with the pattern the sibling docs repos already use instead.
kagent-dev/website#500 now triggers on a release published there, tagged with the kagent release to document. Thanks @EItanya for pointing at the peer precedent. |
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.
Draft until the secrets below exist.
Why
kagent-dev/websiteregenerates the kagent reference docs — the CRD API reference, the Helm values reference, the CLI pages and the version conrefs. It did that nightly from kagentmain, which meant the 1.x docs described code no released kagent contained, while thehelm install --versionline on those same pages named an older release. The 2026-09-22 run documentedKagentHarnessCompactionandKagentHarnessSummarizeron pages pinned to alpha1, a release neither type exists in.That workflow now builds from a release tag (kagent-dev/website#500), so it needs to know when a release happened.
on: releasecan't fire in website for a release published here, so kagent has to tell it.What this adds
One job that dispatches a
kagent-releaseevent carrying the version.It runs after
releaseon purpose — the docs workflow looks the release up by tag and resolves runtime image digests from GHCR, so both have to exist first. It'scontinue-on-errorbecause a missed docs ping is recoverable by dispatching that workflow by hand, and isn't worth failing a release over.The version is sent explicitly rather than letting the docs side fall back to "latest release", so re-running an older tag regenerates that release rather than whatever is newest.
What's needed before this can merge
Two Actions secrets in this repo, from a GitHub App owned by kagent-dev:
APP_IDAPP_PRIVATE_KEYThe App needs Contents: Read and write, installed on
kagent-dev/websiteonly. That's the sole permissionrepository_dispatchrequires. An org owner has to create it —GITHUB_TOKENis scoped to this repository and can't dispatch across repos.A fine-grained PAT with the same permission works too, if that's preferred; it's a two-line change here.
🤖 Generated with Claude Code