https://github.com/orlovm/wiki-action

Action to update repository's wiki with changes from main repository.
https://github.com/orlovm/wiki-action

wiki wiki-files

Last synced: about 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/orlovm/wiki-action
• Owner: orlovm
• License: mit
• Created: 2021-04-24T18:30:16.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2022-10-31T11:01:16.000Z (about 2 years ago)
• Last Synced: 2024-12-01T03:13:14.434Z (about 2 months ago)
• Topics: wiki, wiki-files
• Language: Shell
• Homepage:
• Size: 31.3 KB
• Stars: 11
• Watchers: 1
• Forks: 3
• Open Issues: 2
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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:

```yaml

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:

- `path`: (string, required): The directory where your files are located. 

- `token`: (string, required): GitHub access token. In common case it will be appropriate to use GitHub provided action token "${{ secrets.GITHUB_TOKEN }}". More info: https://docs.github.com/en/actions/reference/authentication-in-a-workflow