Skip to content

Add workflow to sync Document/ directory to repository wiki#36

Merged
shun126 merged 3 commits into
mainfrom
codex/find-solution-to-publish-files-to-wiki
May 16, 2026
Merged

Add workflow to sync Document/ directory to repository wiki#36
shun126 merged 3 commits into
mainfrom
codex/find-solution-to-publish-files-to-wiki

Conversation

@shun126

@shun126 shun126 commented Mar 18, 2026

Copy link
Copy Markdown
Owner

Motivation

  • Automate publishing of documentation from the Document/ directory to the repository wiki on changes to main or via manual dispatch.
  • Avoid attempting to publish for private repositories or when the wiki feature is disabled.

Description

  • Add .github/workflows/publish-document-to-wiki.yml to trigger on pushes to main affecting Document/** and on workflow_dispatch.
  • Use actions/checkout@v4 and actions/github-script@v7 to detect repository visibility and whether the wiki is enabled, and skip publishing when not allowed.
  • Authenticate with GITHUB_TOKEN, replace the wiki repository files with the contents of Document/, set the action author to github-actions[bot], and apply updates only when differences are detected.
  • Request contents: write permissions so the workflow can update the wiki repository.

Testing

  • No automated tests were run for this workflow file.

Codex Task

@shun126 shun126 self-assigned this May 16, 2026
@shun126 shun126 added the documentation Improvements or additions to documentation label May 16, 2026
@shun126 shun126 merged commit 41d5876 into main May 16, 2026
1 check passed
@shun126 shun126 deleted the codex/find-solution-to-publish-files-to-wiki branch May 16, 2026 19:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

codex documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant