> For the complete documentation index, see [llms.txt](https://docs.currents.dev/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.currents.dev/~/changes/TYKBeqcc7WyqjmgOzWzB/guides/playwright-annotations.md).
# Playwright Annotations
Using Playwright Annotations to enhance reporting to Currents dashboard
{% hint style="info" %}
Requires `@currents/playwright` 1.5.0+
{% endhint %}
[Playwright Annotations](https://playwright.dev/docs/test-annotations) is a flexible way to add additional information about tests, like:
* ownership information
* metadata
* links to external resources (Jira ticket, GitHub issue)
* notes
Together with [Playwright Tags](/~/changes/TYKBeqcc7WyqjmgOzWzB/guides/playwright-tags.md) it allows augmenting your testing suite more data for easier managing, better reporting and improved integration.
You can add an annotation to a test by setting `annotations` object to `test` definition or invoking `testInfo.annotations.push` , for example
```typescript
test("annotated test", {
annotation: {
type: "issue",
description: "https://github.com/microsoft/playwright/issues/23180",
},
}, async ({ page }, testInfo) => {
testInfo.annotations.push({
type: "note",
description: "This is a note",
});
testInfo.annotations.push({
type: "jira",
description: "https://jira.company.io/ticket/JIRA-123",
});
testInfo.annotations.push({
type: "owner",
description: "johnsmith",
});
});
```
Currents displays the annotations for recorded tests:
Playwright annotations in Currents
Currents will apply the following modifiations to annotations
* types: `skip, fixme, fail` are reserved by Playwright
* `32` max distinct annotations per test, extra annotations will be truncated (sortedby the order of appearance)
* `type` field is limited to `256` characters, the values will be trimmed and truncated to the max length
* `description` field is limited to `2048` characters, the values will be trimmed and truncated to the max length
* If `type` field is empty after trimming, the annotation will be ignored
* fields with the same `type` will be merged - their description will be merged into one field, separated by comma
### Test Owners
While Currents displays all the annotations related to a test, some annotation have a special meaning, for example - test owner.
To designate an owner of a test, add annotation with `type: owner`, for example:
```
testInfo.annotations.push({
type: "owner",
description: "johnsmith",
});
```
The value will appear in various areas of the dashboard so that your team can quickly identify the who owns the test.
Showing test owner using annotations in Currents
#### Slack notification for Test Owners
Currents will mention the test owners when their tests fail via Slack (if Slack integration is enabled). Currents will send the list of failed tests together with the associated owners - if the owner field value container their [Slack username](https://www.highviewapps.com/kb/how-do-i-find-my-slack-username/), they will activate the "mention" notification.
* Add Slack username, like `johnsmith` to notify individual users
* Add `` to notify the whole channel associated with the Slack integration (equivalent to typing `@channel` in Slack UI)
You can specify multiple owners using comma-separated value, for example `user1, user2`
Using Slack to activate Slack notifications
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.currents.dev/~/changes/TYKBeqcc7WyqjmgOzWzB/guides/playwright-annotations.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
