Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zheng-bote/gh-a_cr-wiki
Github Actions to upload the contents of a directory to your project's wiki.
https://github.com/zheng-bote/gh-a_cr-wiki
actions
Last synced: about 1 month ago
JSON representation
Github Actions to upload the contents of a directory to your project's wiki.
- Host: GitHub
- URL: https://github.com/zheng-bote/gh-a_cr-wiki
- Owner: Zheng-Bote
- License: mit
- Created: 2024-08-19T13:42:56.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2024-08-25T08:54:14.000Z (3 months ago)
- Last Synced: 2024-10-13T23:03:16.885Z (about 1 month ago)
- Topics: actions
- Language: Shell
- Homepage:
- Size: 48.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Github Wiki Publish Action
This GitHub Action publishes the contents of a directory to your project's wiki from a workflow.
## Content
Table of Contents
- [Usage](#usage)
- [Setup](#setup)
- [1. Enable Your Repository's Wikis Feature](#1-enable-your-repositorys-wikis-feature)
- [2. Create the First Wiki Page](#2-create-the-first-wiki-page)
- [3. Generate a Personal Access Token](#3-generate-a-personal-access-token)
- [4. Set a Repository Secret](#4-set-a-repository-secret)
- [License](#license)
## Usage
In a new or existing workflow,
add a step using `Zheng-Bote/gh-a_cr-wiki@main`
with a path to a directory containing the documentation you wish to upload.
```yml
name: add Wiki pages
on: [push]
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Additional steps to generate documentation in "Documentation" directory
- name: Upload Documentation to Wiki
uses: Zheng-Bote/gh-a_cr-wiki@v1
with:
path: path/to/your/docs/
env:
GH_PERSONAL_ACCESS_TOKEN: ${{ secrets.GH_PERSONAL_ACCESS_TOKEN }}
```
## Setup
This GitHub action requires that your repository has the following:
- A wiki with at least one page in it
- A secret named `GH_PERSONAL_ACCESS_TOKEN`
with a Github personal access token with "repo" authorization
Follow the steps below to ensure that everything's configured correctly.
> **Note**
> GitHub doesn't currently provide APIs for interacting with project wikis,
> so much of the required setup must be done manually.
### 1. Enable Your Repository's Wikis Feature
Navigate to the "Settings" tab for your repository,
scroll down to the "Features" section,
and ensure that the checkbox labeled "Wikis" is checked.
### 2. Create the First Wiki Page
With the Wikis feature enabled for your repository,
navigate to the "Wiki" tab.
If prompted,
create the first wiki page.
### 3. Generate a Personal Access Token
Navigate to the [Personal access tokens](https://github.com/settings/tokens) page
in your GitHub account settings
(Settings > Developer settings > Personal access tokens)
and click the "Generate a new token" button.
In the "New personal access token" form,
provide a descriptive comment in the "Note" field, like "Wiki Management".
Under "Select scopes",
enable all of the entries under "repo" perms.
When you're done,
click the "Generate token" button at the bottom of the form.
> **Note**:
> GitHub actions have access to [a `GITHUB_TOKEN` secret][GITHUB_TOKEN],
> but that token's permissions are limited to
> the repository that contains your workflow.
> This workflow requires the generation of a new personal acccess token
> to read and write to the git repository for your project's wiki.
### 4. Set a Repository Secret
Copy your generated personal access token to the clipboard
and navigate to your project settings.
Navigate to the "Secrets" page,
click "Add a new secret",
and fill in the form by
entering `GH_PERSONAL_ACCESS_TOKEN` into the "Name" field and
pasting your token into the "Value" field.
## License
MIT