Home

Awesome

<p align="center"> <img src="./meta/check.png" width="700" alt="codechecks.io"> <h3 align="center">Commit Deployment</h3> <p align="center">Ship every code change that you make</p> <p align="center"> <a href="https://circleci.com/gh/codechecks/commit-deployment"><img alt="Build Status" src="https://circleci.com/gh/codechecks/commit-deployment/tree/master.svg?style=svg"></a> <a href="/package.json"><img alt="Software License" src="https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square"></a> </p> </p>

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<br>
Relative (to current codechecks file) path to build that is supposed to be deployed.

rootFile

optional string<br>
Default: index.html<br>
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