Skip to content

Add the plan to finish the API-docs migration - #7

Closed
alexander-yevsyukov wants to merge 6 commits into
masterfrom
publish-api-docs-wave
Closed

alexander-yevsyukov wants to merge 6 commits into
masterfrom
publish-api-docs-wave

Conversation

@alexander-yevsyukov

@alexander-yevsyukov alexander-yevsyukov commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Adds the plan for moving the last SDK repositories in summit to the API-docs
publishing of SpineEventEngine/config#815. That change splits API-docs
publishing from Maven publishing. The task updateGitHubPages becomes
publishApiDocs, a root publishAllApiDocs task collects the modules' docs,
publish no longer depends on the docs, and a new publish-api-docs.yml
workflow publishes them on every push to master. Since
SpineEventEngine/config#817, ./config/pull also rewrites the repository's own
Gradle scripts for the new names.

The plan is .agents/tasks/publish-api-docs-wave.md. It holds:

  • Status on each repository's master as of 2026-11-04. Eleven
    repositories already took the change, in the cascade-refresh-604420c wave
    or in their own PRs, and every publish-api-docs.yml run so far is green.
    Seven remain: base-libraries, testlib, change, reflect, logging,
    dokka-tools, and base-types. A dry run of the rewrite on the first three
    rewrote them completely and reported nothing, so no hand edit is expected;
    the other four need only the pull.
  • The wave plan: a refresh cascade wave over the seven. After each
    PREP, it checks the pull's output and runs dry-run proofs; after each
    merge, it watches the repository's first Publish and publish-api-docs.yml
    runs.
  • A watch item for the first release version, whose docs run is the first
    real gh-pages clone and push from config#815.
  • Repositories outside summit that still use the old task, and why they
    are out of scope.

Nothing in a consumer repository changes with this PR. Both config PRs are
merged and the previous wave is closed; the wave over the seven runs from the
main summit checkout.

Two behaviour changes are recorded in the plan. change starts publishing API
docs from its next release version, as approved; tool-base, the other such
repository, 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-docs approved the revision. There
is no version gate, because summit has no version.gradle.kts.

Per the task-file lifecycle, the plan file is deleted once the wave is done.

🤖 Generated with Claude Code

alexander-yevsyukov and others added 3 commits October 21, 2026 20:55
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>
@alexander-yevsyukov
alexander-yevsyukov marked this pull request as ready for review October 22, 2026 17:54
Copilot AI balanced review requested due to automatic review settings October 22, 2026 17:54
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-22T17:57:37.794001Z b812455 Draft marked ready
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🔵 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

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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".

Comment thread .agents/tasks/publish-api-docs-wave.md Resolved
`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>
@alexander-yevsyukov alexander-yevsyukov self-assigned this Oct 23, 2026
@alexander-yevsyukov alexander-yevsyukov moved this to 📋 Backlog in v2.0 Oct 23, 2026
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>
@alexander-yevsyukov alexander-yevsyukov changed the title Add the plan for the API-docs consumer wave Add the plan to finish the API-docs migration Nov 4, 2026
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>
@alexander-yevsyukov

Copy link
Copy Markdown
Contributor Author

Closing without merging. The wave this plan drove is done, and its last open item is already met.

  • The wave cascade-refresh-1dbad1f-publish-api-docs is closed. Its record is on master through Archive the cascade-refresh-1dbad1f-publish-api-docs wave #8, under .agents/tasks/archive/.

  • Step 4a, the first publish-api-docs.yml run on a release version, has already happened twice. Both runs were green, and both pushed to gh-pages with the commit wording from Publish API docs apart from Maven publishing config#815 ("Publish the <format> documentation of the module … for the version …"):

    • delivery 0.24.1: run 39966111415, 2026-10-23, 8 gh-pages commits for 4 modules;
    • ProtoTap 0.17.5: run 41521861580, 2026-11-02, 6 gh-pages commits for 3 modules.

    So the sparse gh-pages clone and push from config#815 works on release versions, and there is nothing to report on config.

Under the task-file lifecycle, a plan file is deleted once its wave is done, so this one does not need to land on master. Its history stays readable here.

@github-project-automation github-project-automation Bot moved this from 📋 Backlog to ✅ Done in v2.0 Nov 6, 2026
@alexander-yevsyukov
alexander-yevsyukov deleted the publish-api-docs-wave branch November 6, 2026 18:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

2 participants