Skip to content

Conversation

@aRustyDev
Copy link
Owner

Summary

Adds a GitHub Actions workflow to automatically sync the wiki/ folder to the GitHub Wiki whenever changes are pushed to main.

Related Issues

Type of Change

  • CI/CD

MCP Server(s) Affected

None - this is a repository CI/CD configuration.

Implementation Details

This workflow uses Andrew-Chen-Wang/github-wiki-action@v4 to:

  • 📂 Keep wiki docs in sync with code in the wiki/ folder
  • 🔁 Automatically publish on push to main
  • ✨ Preprocess markdown (converts README.mdHome.md, rewrites .md links)

Workflow Triggers

  • Push to main branch when files change in:
    • wiki/**
    • .github/workflows/wiki-updates.yml
  • Manual trigger via workflow_dispatch

Features

Feature Value
Source Path wiki/
Strategy clone (default - preserves history)
Preprocess true (README.md → Home.md, link rewriting)
Concurrency Single run, cancel in-progress

Checklist

  • Labels applied correctly
  • Documentation updated (if applicable)

Prerequisites

⚠️ Important: Before this workflow can run successfully:

  1. A dummy wiki page must be created manually in the GitHub Wiki tab (this initializes the wiki Git backend)
  2. The wiki/ folder should exist with at least one markdown file

Testing

Workflow will trigger on merge to main when wiki/ folder contents change.

References

integration(pr-template): Adding PR template for adding new templates
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.

2 participants