Miss any of our Open RFC calls?Watch the recordings here! »

@codechecks/commit-deployment

0.1.0 • Public • Published

codechecks.io

Commit Deployment

Ship every code change that you make

Build Status Software License

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

Install

npm i @codechecks/commit-deployment

DownloadsWeekly Downloads

12

Version

0.1.0

License

MIT

Unpacked Size

9.45 kB

Total Files

13

Last publish

Collaborators

  • avatar