Skip to content

ci: add website workflow to publish docs#163

Closed
luoyuxia wants to merge 1 commit intoapache:mainfrom
luoyuxia:feat/website-gh-pages-workflow
Closed

ci: add website workflow to publish docs#163
luoyuxia wants to merge 1 commit intoapache:mainfrom
luoyuxia:feat/website-gh-pages-workflow

Conversation

@luoyuxia
Copy link
Copy Markdown
Contributor

@luoyuxia luoyuxia commented Mar 30, 2026

Purpose

Linked issue: close #148
Enable automated website publishing for paimon-rust so documentation updates can be built and deployed consistently on every push to main.

Brief change log

  • Add .github/workflows/website.yml.
  • Build docs with MkDocs from docs/mkdocs.yml.
  • Use scheme B path handling:
    • run build in docs/
    • output to repo-root _site
    • copy .asf.yaml into _site/.asf.yaml
  • Deploy built site to gh-pages branch via peaceiris/actions-gh-pages.
  • Trigger strategy:
    • push to main: always run website build/deploy
    • pull_request: run only when docs/workflow files are touched

Tests

Already verify it in my own fork.
https://luoyuxia.github.io/paimon-rust/

API and Format

Documentation

@luoyuxia luoyuxia force-pushed the feat/website-gh-pages-workflow branch from 8a09927 to 1f7792c Compare March 30, 2026 11:17
@luoyuxia luoyuxia force-pushed the feat/website-gh-pages-workflow branch from 1f7792c to 0bf7487 Compare March 30, 2026 11:23
@luoyuxia
Copy link
Copy Markdown
Contributor Author

after discuss with @JingsongLi offline, we will publish in https://github.com/apache/paimon-website. I'll close this pr

@luoyuxia luoyuxia closed this Mar 30, 2026
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.

Setup the web site for paimon

1 participant