You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
GitHub Action
GitHub Wiki Action
v1
Updates your GitHub wiki by using rsync.
This action updates your repository's wiki based on a single directory that matches with your Wiki's git.
It is recommended that you still have a Home.md or whatever extension you want instead of MD.
Largely inspired by https://github.com/Decathlon/wiki-page-creator-action and the issue that arose from it, this GitHub action tries to update the entire wiki based on all your files' diffs, additions, and removals.
You must have a single wiki page available from the beginning. It can be blank, but there must be at least one page that exists.
name: Deploy Wiki
on:
push:
paths:
# Trigger only when wiki directory changes
- 'wiki/**'
branches:
# And only on master branch
- master
jobs:
deploy-wiki:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Push Wiki Changes
uses: Andrew-Chen-Wang/github-wiki-action@v1
env:
# Make sure you have that / at the end. We use rsync
WIKI_DIR: wiki/
GH_PAT: ${{ secrets.GH_PAT }}
GH_MAIL: ${{ secrets.YOUR_EMAIL }}
GH_NAME: ${{ github.repository_owner }}You're going to need a Personal Access Token with the minimal scopes of seen here.
Copyright 2020 Andrew Chen Wang
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.