https://github.com/codechecks/commit-deployment

Ship every code change that you make
https://github.com/codechecks/commit-deployment

Last synced: about 2 months ago
JSON representation

Ship every code change that you make

• Host: GitHub
• URL: https://github.com/codechecks/commit-deployment
• Owner: codechecks
• License: mit
• Created: 2019-04-01T17:08:28.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-05-22T23:20:59.000Z (over 5 years ago)
• Last Synced: 2024-07-04T23:02:31.161Z (3 months ago)
• Language: TypeScript
• Size: 230 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  
Commit Deployment

  
Ship every code change that you make


  


    

    

  


## Install

```sh

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

```

or

```sh

yarn add --dev @codechecks/commit-deployment

```

## Usage

Add to your `codechecks.yml` file:

```yml

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\

#### Options

```typescript

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](./CONTRIBUTING.md)

## Licence

MIT @ [codechecks.io](https://codechecks.io)