Github wiki sync repository action

Create / Generate / Update Github wiki based on your repository documentation

Usages

Versions

Stable Version GitHub Release

Requires

Workflow permissions read and write (Allow permissions in your repository Settings -> Actions -> General -> Workflow permissions (section) -> Read and write permissions)
(maybe) inicialized Github wiki

Example

name: Update Github wiki

on:
  push:
    branches:
      - main
      - master

permissions:
  contents: write

jobs:
  update-wiki:
    runs-on: ubuntu-latest
    permissions:
      contents: write
    steps:
      - name: Update wiki
        uses: gouef/github-wiki-sync-repository-action@main
        with:
          dir: "docs/"
        env:
          GITHUB_TOKEN: $

Contributors