Overview

This package provides a way to deploy documentation files to a Google Cloud Storage Bucket, either via typescript, or a CLI.

From code

import { deployDocs } from '@rocketmakers/shell-deploy-docs';
import { ShellExecutor } from '@rocketmakers/shell-executor';
import { join } from 'path';

const shell = new ShellExecutor();

await deployDocs(shell, {
  packageName: 'some-package,
  pathToDocs: join('_docs', '_site'),
  version: '1.2.3',
});

From CLI

pnpm exec rocketmakers-deploy-docs -d=_/docs/_site -p=some-package -v=1.2.3 -l=trace

# Run the following to see expected args and valid values
pnpm exec rocketmakers-deploy-docs --help