Skip to content

Commit

Permalink
feat(test): Add 'url' field to annotations
Browse files Browse the repository at this point in the history
The 'url' field is added to the test annotations to provide a distinct way to store links alongside descriptions. This change allows annotations to include URLs for improved clarity and direct linking, which enhances test report organization.

References: microsoft#30095
  • Loading branch information
osohyun0224 committed May 5, 2024
1 parent b5e3658 commit c38d9ff
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion packages/playwright/src/common/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export type FixturesWithLocation = {
fixtures: Fixtures;
location: Location;
};
export type Annotation = { type: string, description?: string };
export type Annotation = { type: string, description?: string, url?: string };

export const defaultTimeout = 30000;

Expand Down
5 changes: 5 additions & 0 deletions packages/playwright/types/test.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7998,6 +7998,11 @@ export interface TestInfo {
* Optional description.
*/
description?: string;

/**
* Optional URL to provide additional context or link to an issue tracker.
*/
url?: string;
}>;

/**
Expand Down

0 comments on commit c38d9ff

Please sign in to comment.