Skip to content

feat: Add GitHub Action to auto-sync wiki from a /docs (or /wiki) folder in the repository#4259

Open
Ma77Ball wants to merge 5 commits intoapache:mainfrom
Ma77Ball:feat/github_wiki_folder
Open

feat: Add GitHub Action to auto-sync wiki from a /docs (or /wiki) folder in the repository#4259
Ma77Ball wants to merge 5 commits intoapache:mainfrom
Ma77Ball:feat/github_wiki_folder

Conversation

@Ma77Ball
Copy link
Contributor

@Ma77Ball Ma77Ball commented Mar 5, 2026

What changes were proposed in this PR?

This PR adds a GitHub Actions workflow (.github/workflows/sync-wiki.yml) that automatically syncs the contents of a docs/wiki/ folder in the main repository to the GitHub wiki on every push to main.
Before: Wiki pages could only be edited by project committers with direct write access to the GitHub wiki, making documentation contributions impossible via the standard PR process.
After: Any contributor can open a PR modifying markdown files under docs/wiki/, and upon merge the wiki is updated automatically. This mirrors the exact structure of the existing wiki — filenames map directly to wiki page names.
Changes included:

New workflow file: .github/workflows/sync-wiki.yml
New folder: docs/wiki/ seeded with the current wiki content as a baseline

Any related issues, documentation, discussions?

Resolves #4258

How was this PR tested?

The workflow was tested by pushing a change to a file in docs/wiki/ on a fork with wiki enabled and confirming the target wiki page updated correctly after the Action completed. No unit tests apply to this change as it is purely CI/CD infrastructure. The Action itself (Andrew-Chen-Wang/github-wiki-action) is a well-maintained open source action with its own test coverage.
Manual verification steps:

Fork the repo and enable the wiki on the fork
Add WIKI_PUSH_TOKEN as a repo secret (or confirm GITHUB_TOKEN has wiki write permissions)
Merge a small edit to a file in docs/wiki/
Confirm the corresponding wiki page reflects the change

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

Reviewed by Claude

@github-actions github-actions bot added feature ci changes related to CI docs Changes related to documentations labels Mar 5, 2026
@Ma77Ball
Copy link
Contributor Author

Ma77Ball commented Mar 5, 2026

@chenlica or @bobbai00, please review.

@chenlica
Copy link
Contributor

chenlica commented Mar 5, 2026

@Ma77Ball Let's have a discussion then report the finding in this PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci changes related to CI docs Changes related to documentations feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add GitHub Action to auto-sync wiki from a /docs (or /wiki) folder in the repository

2 participants