For commit snapshots
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
test
.gitignore
.jshintrc
LICENSE
README.md
index.js
package-lock.json
package.json

README.md

Snapshot Generator

This app monitors the push event of a repository and generate snapshots for the spec in the repository.

Install

Once the Webhook is created, you must add a configuration file (.pr-preview.json) to the root of your repository. Nothing will happen until you do.

Configuration file

You can configure Snapshot Generator by adding a .pr-preview.json file at the root of your repository with the following fields:

{
    "src_file": "index.bs",
    "type": "bikeshed"
}

src_file (required)

This should point to the relative path to the source file from the root of the repository.

type (required)

One of "bikeshed" or "respec".

Acknowledgments