Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add new config prop populateGitInfo #34329

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

vitalets
Copy link
Contributor

Fixes #34094

This comment has been minimized.

@vitalets
Copy link
Contributor Author

vitalets commented Jan 16, 2025

@yury-s thanks for the review.

  • described populateGitInfo property in doc
  • inverted dependency to GitCommitInfoPlugin

This comment has been minimized.

@vitalets vitalets requested a review from yury-s January 16, 2025 07:59
@@ -64,6 +64,12 @@ See [`property: TestConfig.maxFailures`].

See [`property: TestConfig.metadata`].

## property: FullConfig.populateGitInfo
Copy link
Member

Choose a reason for hiding this comment

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

We try to not add new properties to FullConfig unless there is a strong need for it. Can you store it as FullConfigInternal.populateGitInfo instead ? Should be similar to tsconfig.

@@ -321,6 +321,22 @@ This path will serve as the base directory for each test file snapshot directory
## property: TestConfig.snapshotPathTemplate = %%-test-config-snapshot-path-template-%%
* since: v1.28

## property: TestConfig.populateGitInfo
* since: v1.50
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* since: v1.50
* since: v1.51

We are going to cut 1.50 branch in the next few days and would like to push this feature to the next release.

* since: v1.50
- type: ?<[boolean]>

Whether to populate [`property: TestConfig.metadata`] with Git info.
Copy link
Member

Choose a reason for hiding this comment

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

Maybe also mention that the metadata will automatically appear in the html report, otherwise it's not clear what the use of the option?

@@ -70,6 +71,8 @@ export class Runner {
const config = this._config;
const listOnly = config.cliListOnly;

addGitCommitInfoPlugin(config);
Copy link
Member

Choose a reason for hiding this comment

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

We'll also need similar call in testServer.ts, so that it works in UI mode and with the extension. Let's add a UI mode test for the property.

Copy link
Contributor

Test results for "tests 1"

7 flaky ⚠️ [firefox-page] › tests/page/page-evaluate.spec.ts:403:3 › should throw for too deep reference chain @firefox-ubuntu-22.04-node18
⚠️ [playwright-test] › tests/ui-mode-test-ct.spec.ts:252:5 › should watch component when editing util @macos-latest-node18-1
⚠️ [playwright-test] › tests/ui-mode-trace.spec.ts:341:5 › should work behind reverse proxy @ubuntu-latest-node22-1
⚠️ [webkit-library] › tests/library/screenshot.spec.ts:77:14 › page screenshot › should work with device scale factor @webkit-ubuntu-22.04-node18
⚠️ [webkit-library] › tests/library/selector-generator.spec.ts:362:5 › selector generator › should match in deep shadow dom @webkit-ubuntu-22.04-node18
⚠️ [webkit-library] › tests/library/tracing.spec.ts:432:14 › should produce screencast frames crop @webkit-ubuntu-22.04-node18
⚠️ [webkit-page] › tests/page/page-set-input-files.spec.ts:39:3 › should upload a folder @webkit-ubuntu-22.04-node18

37606 passed, 648 skipped
✔️✔️✔️

Merge workflow run.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs]: Improve documentation for metadata
2 participants