Auto-sync docs on stacklok-enterprise-platform release
维护者通常 1 天内回复
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 冷清
- 技术栈
- github-actions, javascript, typescript, yaml
- 领域
- ci-cd, documentation, tooling
调研方向
从 .github/workflows/upstream-release-docs.yml、.github/upstream-projects.yaml 以及 scripts/upstream-release/ 下现有的 helper 入手,了解当前的项目流程。然后检查现有的 upstream-release-docs skill 和文档约定,再解决未决问题;完成的标准是具备 SEP 配置、manifest 同步、enterprise 标记指南、支持 SEP 的 skill 行为、reviewer 分配,以及一次成功的回填 dry run。
由索引模型根据 Issue 内容生成。
描述
Context
When `toolhive` releases, this repo's `upstream-release-docs.yml` auto-syncs:
- Renovate watches `.github/upstream-projects.yaml` → opens a version-bump PR on a new toolhive tag
- The workflow fires on PR open, shallow-clones toolhive at the new tag, extracts release assets, runs the `upstream-release-docs` Claude skill to write narrative changes, then a `docs-review` pass for polish
We want the same flow for `stacklok-enterprise-platform` (SEP) releases, with one twist: enterprise docs are intermixed with OSS docs. The "enterprise manager" gets its own enterprise-only section, but most enterprise content is inline on OSS pages using an enterprise tag/admonition. The skill needs to know when to inline-tag vs. when to add a standalone enterprise-only page.
The companion SEP-side work (publishing release manifests) is tracked in stacklok/stacklok-enterprise-platform#1294.
Design choice: extend, don't fork
`upstream-release-docs.yml` should become project-aware rather than being cloned into `enterprise-release-docs.yml`. Reasons:
- Enterprise content lives in the same files as OSS content — two workflows touching the same paths would race
- 80% of the workflow (asset sync, skill invocation, reviewer assignment, PR augmentation) is identical
- Project-specific logic (CRD extraction for toolhive, manifest parsing for SEP) is already factored into helper scripts under `scripts/upstream-release/`
Proposed work
1. Onboard SEP into `.github/upstream-projects.yaml`
Add an entry pointing at `stacklok/stacklok-enterprise-platform` with:
- The release assets to sync (`component-versions.yaml`, `enterprise-features.yaml`, `vex.json` — see stacklok/stacklok-enterprise-platform#1294)
- `docs_paths` hints scoped to enterprise pages and the enterprise-only section
- A `depends_on: toolhive` constraint so SEP's PR refuses to merge until the matching toolhive version bump has landed (avoids overwriting freshly-tagged inline content)
2. New helper script: `scripts/upstream-release/sync-sep-manifests.mjs`
- Reads `component-versions.yaml` and `enterprise-features.yaml` from the cloned SEP release
- Updates the compatibility matrix data file (path TBD — `data/compatibility.yaml`?)
- Materializes the features list into a structured input the skill will consume (e.g. `/tmp/sep-features.json`)
- Optionally renders `vex.json` into the CVE transparency page
3. Enterprise-tagging convention doc
Author a doc the skill can read (e.g. `.claude/conventions/enterprise-tagging.md`) covering:
- The exact tag/admonition syntax (`:::enterprise`? MDX component? — pick one and document it)
- When to use inline tagging (`surface: inline-overlay`) vs. a standalone enterprise-only page (`surface: standalone`)
- Voice/style rules for enterprise content
- Examples of well-formed inline-tagged pages
Without this doc, the skill is guessing — this is the single biggest quality lever.
4. SEP-aware skill prompt
Either:
- (A) Extend the existing `upstream-release-docs` skill with project-conditional branches that read `enterprise-features.yaml` and produce inline-tagged content, OR
- (B) Add a sibling `sep-release-docs` skill that the workflow picks based on the project key
Recommend (A) since the docs-review pass is already shared and the asset-sync phase is identical — having one skill that handles both projects keeps the editorial voice consistent.
The skill needs to:
- Map each `enterprise-features.yaml` entry to a content surface (inline edit vs. new page)
- Reference the toolhive version pinned in `component-versions.yaml` when writing inline content (so feature docs stay version-accurate)
- Emit `NO_CHANGES.md` when SEP ships a pure version-bump release with no narrative changes (common case — most SEP releases just re-roll the umbrella chart)
5. Reviewer-assignment tweak
The existing reviewer logic pulls contributors from the upstream release. For SEP, prefer contributors from the SEP repo + anyone tagged on `enterprise-features.yaml` entries.
Acceptance criteria
- SEP entry in `.github/upstream-projects.yaml` with asset declarations + `depends_on` constraint
- `sync-sep-manifests.mjs` script reading the two manifests
- `.claude/conventions/enterprise-tagging.md` authored and linked from the skill prompt
- Skill (or skill-pair) handles SEP releases end-to-end
- Dry-run against a backfilled SEP release (see SEP issue) produces a sane PR
- Reviewer assignment pulls from SEP contributors
Open questions
- Tag/admonition syntax for inline enterprise content — does one already exist in this repo, or do we pick now?
- Where does the compatibility matrix live and how is it currently rendered?
- Should the SEP sync be gated behind a feature flag for the first few releases so a bad run doesn't pollute live docs?
- 主要语言
- TypeScript
- 星标
- 4
- 派生
- 4
- 平均合并
- 1 天 1 小时
- 30 天内合并 PR
- 60
环境准备
在浏览器里用你自己的 GitHub 账号启动这个项目的开发容器。
- 没有 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
stacklok/docs-website 的其他 Issue
-
documentation enhancement needs-triage
难度 1/5 1 小时以内 新手友好度 85/100
stacklok/docs-website#1241 ·
维护者通常 1 天内回复
-
bug documentation needs-triage
难度 2/5 1-3 小时 新手友好度 72/100
stacklok/docs-website#1149 · 2 条评论 ·
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 68/100
stacklok/docs-website#1143 ·
维护者通常 1 天内回复
-
needs-triage
难度 2/5 1-3 小时 新手友好度 72/100
stacklok/docs-website#564 · 1 条评论 ·
维护者通常 1 天内回复
-
documentation enhancement needs-triage
难度 4/5 3-5 天 新手友好度 55/100
stacklok/docs-website#1159 · 1 条评论 ·
维护者通常 1 天内回复
查看 stacklok/docs-website 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 74/100
xdjs/MusicNerdWeb#1532 ·
维护者通常 1 天内回复
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
sebastian-software/ardo#352 ·
维护者通常 1 天内回复
-
@react95/core good first issue
难度 1/5 1 小时以内 新手友好度 88/100
维护者通常 3 天内回复
-
@shikijs/stream: `ShikiStreamTokenizer.clone()` shares its `tokensStable` array with the original可能已有人在做 @xyrolle 今天认领。 未关闭
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 6 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复