Repository navigation
Add the plan to finish the API-docs migration - #7
alexander-yevsyukov wants to merge 6 commits into
Conversation
Inventory and wave plan for adapting the SDK repositories to the `config` change that splits API-docs publishing from Maven publishing (`updateGitHubPages` -> `publishApiDocs`, no `publish` dependency). Phase 2 waits on the `config` merge and the close of the current wave. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Snapshot versions skip only the `gh-pages` push, the root aggregate is named `publishAllApiDocs`, and `migrate` retires a third file, `Update.kt`. Since snapshots never clone or push `gh-pages`, add a step to watch the first release version's docs run. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Fix the nested lists in step 2, the stale task name in Group C, and a step-name reference that `master` does not define. Drop the repeated `File` column from the inventory tables, and reflow lines. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
There was a problem hiding this comment.
🔵 Needs a closer look
The sole changed file is outside automated review scope, so the cross-repository rollout procedure requires human validation.
No open issues 🎉
What changed in this PR
Adds a one-time rollout plan for adapting 18 JVM repositories in summit to the API-docs publishing split in config#815. This PR changes documentation only; it does not modify consumer repositories.
Changes:
- Inventories task references and specifies consumer edits by repository group.
- Defines rollout prerequisites, cascade steps, and dry-run checks.
- Records snapshot behavior and follow-up checks for the first release-time docs publication.
| File | Description |
|---|---|
.agents/tasks/publish-api-docs-wave.md |
Adds the rollout plan; excluded from substantive automated review by repository guidance. |
Review effort: Balanced
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: b812455ff8
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
`summit`'s `master` still names the submodule `delivery-server`, while the GitHub repository is now `delivery`, the name the in-flight wave branch adopts. Say that both names mean the same repository. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
config#817 makes `./config/pull` rewrite the consumer scripts, so the hand edits the plan listed are no longer needed. Eleven repositories already took the change; the plan now tracks the seven that remain, replaces the hand-edit steps with checks of the pull's output, and tightens the context. G1–G3 are done; only the user's go remains. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Tick G4 and steps 1-4, log the scoped wave's PRs and the closing config#836, and keep the file open for step 4a, the first release version's docs run, until a release task file can take it over. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Closing without merging. The wave this plan drove is done, and its last open item is already met.
Under the task-file lifecycle, a plan file is deleted once its wave is done, so this one does not need to land on |
Adds the plan for moving the last SDK repositories in
summitto the API-docspublishing of SpineEventEngine/config#815. That change splits API-docs
publishing from Maven publishing. The task
updateGitHubPagesbecomespublishApiDocs, a rootpublishAllApiDocstask collects the modules' docs,publishno longer depends on the docs, and a newpublish-api-docs.ymlworkflow publishes them on every push to
master. SinceSpineEventEngine/config#817,
./config/pullalso rewrites the repository's ownGradle scripts for the new names.
The plan is
.agents/tasks/publish-api-docs-wave.md. It holds:masteras of 2026-11-04. Elevenrepositories already took the change, in the
cascade-refresh-604420cwaveor in their own PRs, and every
publish-api-docs.ymlrun so far is green.Seven remain:
base-libraries,testlib,change,reflect,logging,dokka-tools, andbase-types. A dry run of the rewrite on the first threerewrote them completely and reported nothing, so no hand edit is expected;
the other four need only the pull.
refreshcascade wave over the seven. After eachPREP, it checks the pull's output and runs dry-run proofs; after eachmerge, it watches the repository's first
Publishandpublish-api-docs.ymlruns.
real
gh-pagesclone and push from config#815.summitthat still use the old task, and why theyare out of scope.
Nothing in a consumer repository changes with this PR. Both
configPRs aremerged and the previous wave is closed; the wave over the seven runs from the
main
summitcheckout.Two behaviour changes are recorded in the plan.
changestarts publishing APIdocs from its next release version, as approved;
tool-base, the other suchrepository, is already migrated. Snapshot versions push no docs to
gh-pages,so the site changes only on release versions.
Pre-PR: Markdown only, so no build.
review-docsapproved the revision. Thereis no version gate, because
summithas noversion.gradle.kts.Per the task-file lifecycle, the plan file is deleted once the wave is done.
🤖 Generated with Claude Code