Open source maintainers, keep repo documentation in sync with the Bi-directional Wiki Sync GitHub Action

GitHub supports a Wiki feature that can allow maintainer teams to manage documentation (such as Runbooks) using common wiki tools, but how do you keep that wiki and the related repo in sync?

That’s what the Bi-directional Wiki Sync Action does for maintainer teams.

  • Make a change in the wiki and see the documentation in the repo’s docs folder (by default docs) sync with the change.
  • Make a change in the repo’s docs folder and automatically sync the change to the repo wiki

This project is available for installation in the GitHub Actions marketplace or you can find it on New Relic Open Source.

Repo: https://github.com/newrelic/wiki-sync-action
Project Homepage: https://opensource.newrelic.com/projects/newrelic/wiki-sync-action
Example implementation: https://github.com/newrelic/opensource-website
GitHub Actions Marketplace: https://github.com/marketplace/actions/bi-directional-wiki-sync-action

2 Likes