Skip to content

Action to update repository's wiki with changes from main repository.

License

Notifications You must be signed in to change notification settings

orlovm/Wiki-Action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

46 Commits
 
 
 
 
 
 
 
 

Repository files navigation

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:

About

Action to update repository's wiki with changes from main repository.

Topics

Resources

License

Stars

Watchers

Forks

Languages