Skip to content

ci: auto-sync docs/ to the website on doc changes#5308

Merged
aglinxinyuan merged 7 commits into
apache:mainfrom
Ma77Ball:sync-docs-to-site
Jun 3, 2026
Merged

ci: auto-sync docs/ to the website on doc changes#5308
aglinxinyuan merged 7 commits into
apache:mainfrom
Ma77Ball:sync-docs-to-site

Conversation

@Ma77Ball
Copy link
Copy Markdown
Contributor

@Ma77Ball Ma77Ball commented Jun 1, 2026

What changes were proposed in this PR?

  • Adds a GitHub Actions workflow that keeps the website docs in sync with this repository, which is the single source of truth for documentation.
  • How it works: when any file under docs/ changes on main, the workflow copies each Markdown page body into the website repo (apache/incubator-texera-site) and pushes it, which triggers the site's existing publish build.
  • It preserves the website's own front matter (page redirects and menu settings) and only replaces the body, so site navigation and aliases are never clobbered; new pages are copied and removed pages are deleted, so the site stays a faithful mirror.
  • The job runs only on apache/texera (forks are skipped) and can also be triggered manually from the Actions tab.

Any related issues, documentation, or discussions?

Related to: #5001

How was this PR tested?

  • Need a token from the incubator GitHub to test

Was this PR authored or co-authored using generative AI tooling?

Co-authored with Claude Opus 4.8 in compliance with ASF

@github-actions github-actions Bot added the ci changes related to CI label Jun 1, 2026
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Jun 1, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 51.29%. Comparing base (6d604f3) to head (b72174c).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #5308      +/-   ##
============================================
+ Coverage     51.14%   51.29%   +0.14%     
- Complexity     2413     2418       +5     
============================================
  Files          1054     1054              
  Lines         40923    40923              
  Branches       4381     4381              
============================================
+ Hits          20932    20993      +61     
+ Misses        18791    18706      -85     
- Partials       1200     1224      +24     
Flag Coverage Δ *Carryforward flag
access-control-service 41.89% <ø> (ø)
agent-service 33.76% <ø> (ø)
amber 51.99% <ø> (+0.37%) ⬆️
computing-unit-managing-service 1.38% <ø> (ø)
config-service 54.68% <ø> (ø)
file-service 38.42% <ø> (ø)
frontend 45.77% <ø> (+0.02%) ⬆️
pyamber 90.69% <ø> (ø)
python 90.83% <ø> (-0.02%) ⬇️ Carriedforward from b90e76d
workflow-compiling-service 58.39% <ø> (ø)

*This pull request uses carry forward flags. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Adds a workflow that mirrors the codebase docs/ tree (the single source of truth) into apache/incubator-texera-site on any docs change on main, then pushes so the site rebuilds. Preserves the site's own front matter (aliases/menu), mirrors adds and deletes, runs only on apache/texera.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Ma77Ball Ma77Ball force-pushed the sync-docs-to-site branch from 685a76f to f9a167a Compare June 1, 2026 20:14
@Ma77Ball
Copy link
Copy Markdown
Contributor Author

Ma77Ball commented Jun 1, 2026

/request-review @aglinxinyuan

@github-actions github-actions Bot requested a review from aglinxinyuan June 1, 2026 20:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a dedicated GitHub Actions workflow to keep the Hugo website documentation in apache/incubator-texera-site synchronized with this repo’s docs/ folder whenever docs/** changes on main (or via manual dispatch), by updating the site repo and pushing a commit to trigger its existing publish pipeline.

Changes:

  • Introduces .github/workflows/sync-docs-to-site.yml to sync docs/ into content/docs/latest/ in the website repo.
  • Uses an inline Python script to preserve target front matter while replacing Markdown bodies, and removes pages that no longer exist upstream.
  • Commits and pushes changes to the website repo with retry + rebase logic.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread .github/workflows/sync-docs-to-site.yml
Comment thread .github/workflows/sync-docs-to-site.yml Outdated
Comment thread .github/workflows/sync-docs-to-site.yml Outdated
Comment thread .github/workflows/sync-docs-to-site.yml Outdated
@aglinxinyuan aglinxinyuan added this pull request to the merge queue Jun 3, 2026
Merged via the queue into apache:main with commit 12d1d60 Jun 3, 2026
24 checks passed
juliethecao pushed a commit to juliethecao/texera that referenced this pull request Jun 4, 2026
### What changes were proposed in this PR?
- Adds a GitHub Actions workflow that keeps the website docs in sync
with this repository, which is the single source of truth for
documentation.
- How it works: when any file under `docs/` changes on `main`, the
workflow copies each Markdown page body into the website repo
(apache/incubator-texera-site) and pushes it, which triggers the site's
existing publish build.
- It preserves the website's own front matter (page redirects and menu
settings) and only replaces the body, so site navigation and aliases are
never clobbered; new pages are copied and removed pages are deleted, so
the site stays a faithful mirror.
- The job runs only on `apache/texera` (forks are skipped) and can also
be triggered manually from the Actions tab.
### Any related issues, documentation, or discussions?
Related to: apache#5001
### How was this PR tested?
- Need a token from the incubator GitHub to test
### Was this PR authored or co-authored using generative AI tooling?
Co-authored with Claude Opus 4.8 in compliance with ASF

---------

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci changes related to CI

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants