Skip to content

Commit

Permalink
docs: last snapshot updates + index update [sc-00] (#936)
Browse files Browse the repository at this point in the history
* docs: last snapshot updates + index update [sc-00]

* chore: update CLI package to 4.4.0
  • Loading branch information
tnolet authored Nov 10, 2023
1 parent 9fad582 commit 43fe3c8
Show file tree
Hide file tree
Showing 7 changed files with 49 additions and 19 deletions.
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
},
"devDependencies": {
"@playwright/test": "1.31.2",
"checkly": "4.4.0-prerelease",
"checkly": "4.4.0",
"eslint": "7.32.0",
"eslint-config-standard": "16.0.3",
"eslint-plugin-html": "7.1.0",
Expand Down
23 changes: 21 additions & 2 deletions site/content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,40 @@ monitoring in minutes.
{{< doc-card
class="two-column-card"
headerTag="h3"
title="Create browser checks"
title="Create a browser check"
img="/docs/images/icons/browser-checks.svg"
description="Use TS / JS with @playwright/test and Headless browsers to navigate, screenshot and assert your key webapp flows."
link="/docs/browser-checks"
>}}
{{< doc-card
class="two-column-card"
headerTag="h3"
title="Create API checks"
title="Create an API check"
img="/docs/images/icons/api.svg"
description="Monitor the latency and assert the correctness of your API endpoints. Use inline scripts and code to customize everything."
link="/docs/api-checks"
>}}
</div>
<div class="cards-list">
{{< doc-card
class="two-column-card"
headerTag="h3"
title="Create a multistep API check"
img="/docs/images/icons/multistep-check.svg"
description="Write Node.js scripts that run multiple API requests in sequence, with arbitrary code between requests and get all the data."
link="/docs/multistep-checks/"
>}}
{{< doc-card
class="two-column-card"
headerTag="h3"
title="Create a heartbeat check"
img="/docs/images/icons/heartbeats-check.svg"
description="Monitor your backup jobs, data imports, and other recurring jobs or scripts by pinging Checkly at a regular interval."
link="/docs/heartbeat-checks/"
>}}
</div>
<div class="cards-list">
{{< doc-card
class="full-width-card"
Expand Down
24 changes: 12 additions & 12 deletions site/content/docs/browser-checks/playwright-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,18 +30,18 @@ A check using [the Playwright Test Runner (`@playwright/test`)](https://playwrig

This is the list of Playwright Test Runner features that are currently supported. We will update it as more features become supported.

| Feature | Supported? |
|--------------------------|--------------------|
| Trace files | Yes |
| Video recordings | Yes |
| API testing | Yes |
| Custom fixtures | Yes |
| Reporters | Only JSON, more to come |
| Typescript | Yes |
| Global configuration | No |
| Visual comparisons | No ([Current feature request](https://github.com/checkly/public-roadmap/issues/179)) |
| Test retry | No <br> Enable Checkly's ["Double-check on failure"](/docs/alerting/#double-checking) in the check settings to retry a check. |
| Parallelism and sharding | No |
| Feature | Supported? |
|--------------------------|-------------------------------------------------------------------------------------------------------------------------------|
| Trace files | Yes |
| Video recordings | Yes |
| API testing | Yes |
| Custom fixtures | Yes |
| Reporters | Only JSON, more to come |
| Typescript | Yes |
| Global configuration | No |
| Visual comparisons | Yes, [check the docs](/docs/browser-checks/visual-comparison-snapshot-testing/) |
| Test retry | No <br> Enable Checkly's ["Double-check on failure"](/docs/alerting/#double-checking) in the check settings to retry a check. |
| Parallelism and sharding | No |

### Browser check with multiple test cases
One of the key benefits of using Playwright Test is that you can split your check into multiple independent test cases,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,15 @@ snapshot testing. This is useful for testing the visual appearance of your appli
- Use the `.toHaveScreenshot()` assertion to visually compare a screenshot of your page to a golden image / reference snapshot.
- Use the `.toMatchSnapshot()` assertion to compare any `string` or `Buffer` value to a golden image / reference snapshot.

This feature works with the following CLI and Checkly Agent versions:

- [Checkly CLI v4.4.0 or later](https://www.npmjs.com/package/checkly/v/4.4.0).
- [Checkly Agent v3.2.0 or later](https://hub.docker.com/layers/checkly/agent/3.2.0/images/sha256-714bbd7302d7c086ef1776014f919c1e9aacdfda450764295147e8f1ab99cb00?context=explore).

{{< info >}}
Visual comparison and snapshot testing is now in **beta**. During beta, this feature is free for all plans.
Any pricing or plans limits will be introduced after the beta.
{{< /info >}}

## Visual comparison testing

Expand Down
1 change: 1 addition & 0 deletions site/static/docs/images/icons/heartbeats-check.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions site/static/docs/images/icons/multistep-check.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

1 comment on commit 43fe3c8

@vercel
Copy link

@vercel vercel bot commented on 43fe3c8 Nov 10, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.