Skip to content

ci: publish docs from scylla-3.x with the default branch's workflow - #1155

Merged
dkropachev merged 1 commit into
scylladb:scylla-3.xfrom
nikagra:fix-3x-docs-workflow
Sep 28, 2026
Merged

dkropachev merged 1 commit into
scylladb:scylla-3.xfrom
nikagra:fix-3x-docs-workflow

Conversation

@nikagra

@nikagra nikagra commented Sep 28, 2026

Copy link
Copy Markdown

Depends on: nothing
Blocks: #1001, #1150, and every fast-forward of scylla-3.11.5.x

A push to scylla-3.x runs its own copy of the docs publish workflow, which rebuilds and deploys the whole site. So does a fast-forward of scylla-3.11.5.x, which now only moves that way. This copy installs JDK 8 only and has no javadoc guard, so the next docs merge here would publish 4.19.2.x, the stable version, without its api/, and report success.

Verified: the file is identical to scylla-4.x's, which publishes green today, and a local four-version multiversion build with this branch's tree as 3.11.5.x built a 678-file api/ with the guard passing. The workflow itself only runs after merge.

Refs #1134

🤖 Generated with Claude Code

A push to this branch runs its own copy of the docs publish workflow,
which rebuilds and deploys the whole site. This copy installs JDK 8
only and has no javadoc guard, so it would publish every JDK 11 version
without its api/. Replace it with scylla-4.x's docs-pages.yml.

Co-Authored-By: Claude Opus 5.5 (1M context) <[email protected]>
@coderabbitai

coderabbitai Bot commented Sep 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: QUIET

Plan: Advanced

Run ID: da54fad4-09d7-4c4b-9e3a-8ff0f509a10b

📥 Commits

Reviewing files that changed from the base of the PR and between 5a2f793 and fd92916.

📒 Files selected for processing (2)
  • .github/workflows/docs-pages.yaml
  • .github/workflows/docs-pages.yml
💤 Files with no reviewable changes (1)
  • .github/workflows/docs-pages.yaml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The pull request replaces the documentation publishing workflow. The new workflow builds multiversion documentation and checks Javadoc output before and after GitHub Pages deployment.

Priority: ➖ Normal

Change: Bug fix

Merge Risk: ⚪ Minimal · up to fd929

No actionable publishing risk remains from the reviewed change; the documentation workflow is ready for normal merge checks.

Architecture Summary

Architecture risk: 🔵 Low · up to fd929

The changed surface does not map to a changed system, dependency edge, entrypoint, or external dependency.

Changed systems: None identified.

Architecture concerns
No architecture-level concerns identified.

Review details

Before / after behavior

  • observed — Modified behavior in .github/workflows/docs-pages.yaml: The documentation publishing workflow was removed, including its push and manual triggers, build setup and steps, and GitHub Pages deployment.
  • observed — Modified behavior in .github/workflows/docs-pages.yml: Defines the workflow name and triggers it on manual dispatch or pushes to scylla-4.x and scylla-** that change files under docs/, faq/, manual/, changelog/, or upgrade_guide/.
  • observed — Modified behavior in .github/workflows/docs-pages.yml: Adds a release job with contents: write permission on ubuntu-latest; runs share the single concurrency group, with in-progress runs canceled.
  • observed — Modified behavior in .github/workflows/docs-pages.yml: Checks out the repository’s default branch with full history and without persisted credentials, sets up Python 3.13 and Temurin Java 8 and 11, installs uv, and runs the docs environment setup.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the CI change: publishing documentation from scylla-3.x with the default branch workflow.
Description check ✅ Passed The description directly explains the workflow replacement, its Javadoc guard, and the reason for the change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@dkropachev
dkropachev merged commit 90082cc into scylladb:scylla-3.x Sep 28, 2026
15 checks passed
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