Reg-publish-github-pages-plugin NPM

reg-publish-github-pages-plugin

version LICENSE

A reg-suit plugin to fetch and publish assets to the GitHub pages.

How it works

overview

The plugin will create orphan branch when you run reg-suit prepare -p publish-github-pages. Then the plugin will commit report pages and images to the branch whenever you run reg-suit run. The branch has completely different tree from your branches. It doesn't affect any existing branches. So you can use it in the same repository you want to introduce reg-suit.

Install

npm i -D reg-publish-github-pages-plugin
reg-suit prepare -p publish-github-pages

Setup

You need to configure GitHub pages before using this plugin.
See the official documentation

Configure

{
  repository: string;
  branchName: string;
  token: string;
  customDomain?: string;
  pathPrefix?: string;
}

repository - Required - A repository name in the form of owner/name such as Leko/reg-publish-github-pages-plugin.
branchName - Required - A branch name for the GitHub pages.
token - Required - A GitHub token. The token must have user:email and public_repo permission. When the repository is private, the token requires repo permission instead of public_repo.
customDomain - Optional - A custom domain when you set it to the GitHub pages.
pathPrefix - Optional - Specify paths. For example, when you set some_dir as this property, this plugin will publish with URL such as https://{TODO}/some_dir/index.html.