ci: publish docs site to datafusion.apache.org/java/#26
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Wires the Sphinx docs site (merged in #24) into Apache's publishing infrastructure so it appears live at
https://datafusion.apache.org/java/.What changed
.asf.yaml— appends apublish:block telling ASF infra to serve theasf-sitebranch under thejavasubdir..github/workflows/docs.yaml— new workflow. Mirrors the layout used bydatafusion-comet, with one addition: it also runs on pull requests as a build-only CI check, so a docs build break cannot land onmain.mainand PRs targetingmain) are path-filtered to.asf.yaml,.github/workflows/docs.yaml, anddocs/**so unrelated changes don't fire it.if: startsWith(github.repository, 'apache/')skips on forks (matches comet).permissions: contents: writeso the publish step can push toasf-sitewithout widening the repo-level default and without affectingbuild.yml'scontents: readscope.asf-sitecheckout and the publish step viaif: github.event_name == 'push').asf-site,touch .nojekyll, commit, force-push asgithub-actions[bot].One-time bootstrap before this can publish
The workflow assumes an
asf-sitebranch exists. Before merging, a maintainer (or ASF infra) needs to create an orphan branch:git switch --orphan asf-site git commit --allow-empty -m "Initial asf-site branch" git push apache asf-siteOnce the branch exists, the first workflow run on
mainwill populate it.Notes
-W(warnings fail the build), so a PR with a broken cross-reference or invalid toctree will fail the check.git push || git push --forceto handle the orphan-branch first-publish case without manual intervention.Not in this PR
asf-staging).