pages

garden github-pages

Publish the given directory to a gh-pages branch.

Usage

import { githubPages } from '@zendeskgarden/scripts';

const args: {
  dir: string;
  disableJekyll?: boolean;
  path?: string;
  message?: string;
  token?: string;
} = {
  dir: __dirname
  /* optional overrides */
};

(async () => {
  const url = await githubPages(args);

  console.log(url);
})();

Arguments

• dir directory of web content to publish.
• no-jekyll disable Jekyll by adding a .nojekyll file.
• path optional path to a git directory; defaults to dir.
• message optional commit message.
• token optional GitHub personal access token; defaults to the value provided by githubToken.

Command

garden github-pages [--no-jekyll] [--path <path>] [--message <message>] [--token <token>] <dir>

To get debug output:

NODE_DEBUG=gh-pages garden github-pages