GitHub Action
Wiki Sync (Fork)
v1
Latest version
This action is designed to sync a folder in your repo with the Wiki Repo, allowing for better contributor worklow and ease of editing the Wiki.
on:
push:
branches:
- master
pull_request:
branches:
- master
name: Wiki Sync
jobs:
update-wiki:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Sync Wiki
uses: joeizzard/action-wiki-sync@master
with:
username: example
access_token: ${{ secrets.GITHUB_TOKEN }}
wiki_folder: wiki
commit_username: 'Example Name'
commit_email: 'example@users.noreply.github.com'
commit_message: 'action: wiki sync'In this example, the wiki folder will be synced with the wiki repo everytime a commit to the master branch occurs or when a pull request to the master branch is merged. This is a fully working example, just change the variables under the with section to get started.
| Input | Required | Info |
|---|---|---|
username |
Y | The repo owner's name. Used for pulling and pushing |
access_token |
Y | An access token to use when pushing to the Wiki repo, can be set using ${{ secrets.GITHUB_TOKEN }} |
wiki_folder |
N | The folder to sync to the Wiki. Default: wiki |
ignore_safe_warnings |
N | Fixes fatal: detected dubious ownership in repository at '/wiki' Default: false |
commit_username |
Y | The username to use when pushing to the wiki repo |
commit_email |
Y | The email address to use when pushing to the wiki repo. Our example uses the annonymous email from GitHub |
commit_message |
N | The commit message to use when pushing to the wiki repo Default: action: wiki sync |
There are no outputs for this action.
The action uses Docker, as such is limited to Linux based runners. It also requires a checkout of the main repo beforehand.
This project is licensed under MIT.
For the full License, Please see the file LICENSE.md