@pixolith/percy-runner

Percy Runner

How to use

put the following object inside a projects root or respective extension package.json. Setup percy.io and connect the project to github. Builds will run on every deployment.

Options

{
    // percy project name (required)
    "project": "wurm-shopware",
    // percy stage (required)
    "stage": {
        // should match the $STAGE var of the deployment
        "staging": {
            // urls to test (required)
            "urls": [
                "/",
                "/saisonale-deko/",
                "/adler-apotheke-bernkastel-porz-b12-x-t15-x-h19-cm/10055366",
                "/unternehmen/",
                "/kontakt/"
            ],
            // additional tests to be run (via the test interface)
            "tests": [
                "./e2e/test.js"
            ],
        },
        "production": {
            "urls": [
                "/",
                "/saisonale-deko/",
                "/adler-apotheke-bernkastel-porz-b12-x-t15-x-h19-cm/10055366",
                "/unternehmen/",
                "/kontakt/"
            ],
            // additional tests to be run (via the test interface)
            "tests": [
                "./e2e/test.js"
            ],
        }
    },
    // the target has always open connections like WS? Set this to true (default = false)
    "noNetworkIdle": false,
    // screen widths to be snapshotted by percy (required)
    "widths": [480, 768, 1024, 1920],
    // screen min-height to be applied in snapshots (default)
    "minHeight": 2000,
    // device scale factor (default)
    "deviceScaleFactor": 1,
    // add custom css to e.G hide an iframe or layer (css string only) (default = "")
    "additionalCSS": "iframe { display: none; }",
    // maximum concurrency in snapshotting - usually this is fine (should not exceed 6) (default)
    "concurrency": 3,
    // options to pass directly to the puppeteer instance (https://github.com/puppeteer/puppeteer/blob/v2.1.1/docs/api.md#puppeteerlaunchoptions) (default)
    "puppeteer": {
        "headless": true,
        "args": ["--window-size=1920,1080"],
    },
};