feat(test): add URL field to annotations for hyperlink display
#30665
+24
−8
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
|
@microsoft-github-policy-service agree |
injae-kim
reviewed
May 5, 2024
packages/playwright/types/test.d.ts
Outdated
Comment on lines
8124
to
8126
| /** | ||
| * Optional URL to provide additional context or link to an issue tracker. | ||
| */ |
There was a problem hiding this comment.
Suggested change
| /** | |
| * Optional URL to provide additional context or link to an issue tracker. | |
| */ | |
| /** | |
| * Optional URL to provide additional context or link to an issue tracker. | |
| */ |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
Added an optional 'url' field to the TestCaseAnnotation type to support hyperlink functionality within test annotations. This update allows annotations to include URLs, enhancing their utility by providing direct links to related resources or issue trackers.
This comment has been minimized.
This comment has been minimized.
Test results for "tests 1"1 failed 27306 passed, 671 skipped Merge workflow run. |
pavelfeldman
approved these changes
May 21, 2024
|
This change looks good. Could you follow up with:
|
|
thanks @osohyun0224 for your change, will this change also fix #30140 ? or that's a separate issue |
|
@saurabhdes Hello :) I checked your issue, and I think it's an issue related to the newly added feature. I kept the title and description as is and added a new url field. But the functional purpose of your issue is the same ;) I am planning to develop additional features suggested by the maintainer. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
related issue: #30095
Description:
This pull request introduces the ability to include
URLdirectly within annotations in Playwright tests, enabling the URLs to be displayed as hyperlinks in test reports.Motivation:
Current annotation functionality only allows for text descriptions, which limits the ability to navigate directly to related resources or issue trackers. By integrating a URL field, we provide a more interactive and informative testing environment.
Changes:
Added an optional url field to the Annotation type to accommodate
URLUpdated type definitions and documentation to reflect the addition.
Expected Outcome:
With the addition of the url field, annotations can now directly link to URLs, which are displayed as hyperlinks in test reports. This update improves the functionality of test descriptions and enhances the accessibility of related online resources.
References:
Closes #30095 - "[Feature]: Show URL's within annotations as hyperlink"
Code Check
�toggle dropdown
I have written a test to ensure that the changes were applied correctly, and I have verified its functionality through screenshots. I examined whether the test is running as expected by capturing images of the test execution results.