Install

npm add --save-dev @codechecks/commit-deployment

or

yarn add --dev @codechecks/commit-deployment

Usage

Add to your codechecks.yml file:

checks:
  - name: commit-deployment
    options:
      buildPath: "./dist"
  # ...

With each pull request you will get a link do current deployment of your frontend app.

API

commitDeployment(options: Options): Promise<void>

Options

interface Options {
  buildPath: string;
  rootFile?: string;
}

buildPath

string
Relative (to current codechecks file) path to build that is supposed to be deployed.

rootFile

optional string
Default: index.html
File considered as root in your build. Attached link will point directly to it.

Contributing

All contributions are welcomed. Read more in CONTRIBUTING.md

Licence

MIT @ codechecks.io