Skip to content

[CI][Docs] Publish PR docs previews to nightlies.apache.org instead of S3 - #68

Draft
rok wants to merge 1 commit into
mainfrom
claude/docs-preview-github-artifacts-12ef8b
Draft

rok wants to merge 1 commit into
mainfrom
claude/docs-preview-github-artifacts-12ef8b

Conversation

@rok

@rok rok commented Nov 17, 2026 •

Copy link
Copy Markdown
Owner

Moves PR docs previews from the crossbow preview-docs task and S3 to GitHub Actions and nightlies.apache.org.

  • Build (docs.yml): uploads the rendered docs as a docs-preview artifact. Runs automatically for PRs that change docs/** or cpp/apidoc/**.

  • Request (comment_bot.yml): on any other PR a committer comments @github-actions docs-preview, which dispatches docs.yml for the PR's current head commit. These builds use no secrets and only restore caches.

  • Publish (docs_preview.yml): on workflow_run, rsyncs the artifact to nightlies.apache.org/arrow/pr_docs/<date>/<PR>/. It never runs PR code and treats the artifact as untrusted.

  • Link: after publishing, the workflow comments on the PR with the preview URL and updates that same comment on later builds:

    📖 Docs preview for <commit>: https://nightlies.apache.org/arrow/pr_docs/<date>/<PR>/index.html
    It is removed after 14 days.

    A failed build posts nothing.

  • Cleanup: the same rsync call deletes previews older than 14 days. No cleanup job, no pull_request_target.

Also:

  • docs_light.yml is renamed to Docs Light, so workflow_run can select the complete build by name.
  • The docs builds no longer receive the Docker Hub credentials; archery docker run never used them.
  • The crossbow preview-docs task, its S3 upload and the old screenshots are removed; the developer docs describe the new flow.

@github-actions

This comment was marked as resolved.

…f S3

The Docs workflow uploads the rendered docs as an artifact. A new Docs
Preview workflow, triggered by workflow_run, syncs it to
nightlies.apache.org/arrow/pr_docs/<date>/<PR>/ and comments the link on
the pull request. The same sync removes previews older than 14 days.

Pull requests that change docs get a preview automatically. For any
other pull request a committer can comment "@github-actions docs-preview",
which dispatches the Docs workflow for the current head commit. Those
builds use no secrets and only restore caches.

This replaces the crossbow preview-docs task and its S3 upload. The docs
builds no longer receive the Docker Hub credentials, which archery
docker run never used.
@rok
rok force-pushed the claude/docs-preview-github-artifacts-12ef8b branch from 1374aff to 729135d Compare November 17, 2026 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant