Skip to content

Update wiki

Actions
This action updates wiki repository with changes made in base repository
v1
Latest
Star (11)

OrlovM/Wiki-Action

Manage your wiki files in your repository. This action will push changes to the wiki repository.


Features

  • Automatically pushes changes from specified directiory to the wiki.
  • Uses author from repository's git commit.
  • Uses the commit message from repository's git commit.
  • It's easy to pull request/merge wiki files.

Usage

You should have a copy of your wiki inside your repository. Use git clone [RepositoryName].wiki.git wiki to clone a wiki repo inside your repository.

If wiki does not exist yet, create an empty page on Github wiki through Github web interface.

Example yaml config:

name: Update Wiki

on:
  push:
    paths:
      - 'wiki/**'
    branches:
      - master
jobs:
  update-wiki:
    runs-on: ubuntu-latest
    name: Update wiki
    steps:
    - uses: OrlovM/Wiki-Action@v1
      with:
        path: 'wiki'
        token: ${{ secrets.GITHUB_TOKEN }}

The possible inputs are:

Update wiki is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.

About

This action updates wiki repository with changes made in base repository
v1
Latest

Update wiki is not certified by GitHub. It is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.