@superdispatch/gh-scripts

gh-scripts

Node scripts for GitHub actions

• gh-scripts
• Commands

Commands

• gh-scripts build-size:report
• gh-scripts build-size:snapshot
• gh-scripts deploy-preview
• gh-scripts help [COMMAND]
• gh-scripts prune-artifacts

gh-scripts build-size:report

Saves build size snapshot

USAGE
  $ gh-scripts build-size:report

OPTIONS
  --dir=dir            (required) Build folder
  --help               show CLI help
  --label=label        Build label
  --snapshot=snapshot  (required) Path to the snapshot file
  --token=token        (required) GitHub access token

See code: lib/commands/build-size/report.js

gh-scripts build-size:snapshot

Saves build size snapshot

USAGE
  $ gh-scripts build-size:snapshot

OPTIONS
  --dir=dir  (required) Specify a build folder
  --help     show CLI help
  --out=out  (required) Specify a path for the snapshot file

See code: lib/commands/build-size/snapshot.js

gh-scripts deploy-preview

Deploy preview

USAGE
  $ gh-scripts deploy-preview

OPTIONS
  --alias=alias                Alias for deployment
  --dir=dir                    (required) Folder to deploy
  --help                       show CLI help
  --label=label                Deployment label
  --netlifySite=netlifySite    (required) Netlify site ID to deploy to
  --netlifyToken=netlifyToken  (required) Netlify access token
  --token=token                (required) GitHub access token

See code: lib/commands/deploy-preview.js

gh-scripts help [COMMAND]

display help for gh-scripts

USAGE
  $ gh-scripts help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

gh-scripts prune-artifacts

Prune artifacts

USAGE
  $ gh-scripts prune-artifacts

OPTIONS
  --help             show CLI help
  --pattern=pattern  [default: .*] RegExp pattern string to match an artifact name
  --token=token      (required) GitHub access token

See code: lib/commands/prune-artifacts.js