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.

Sign up for GitHub

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

Jump to bottom

[Docs]: Improve documentation for metadata #34094

Open
vitalets opened this issue Dec 19, 2024 · 0 comments · May be fixed by #34095
Open

[Docs]: Improve documentation for metadata #34094

vitalets opened this issue Dec 19, 2024 · 0 comments · May be fixed by #34095
Labels
v1.50

Comments

@vitalets
Copy link
Contributor

Page(s)

https://playwright.dev/docs/next/api/class-testconfig#test-config-metadata

Description

1. Current metadata example does not pass TypeScript check:

import { defineConfig } from '@playwright/test';

export default defineConfig({
  metadata: 'acceptance tests',
});

Result:

Type 'string' is not assignable to type 'Metadata'.

2. Documentation should mention the certain fields that are allowed in metadata, e.g.

export type Metainfo = {
  'revision.id'?: string;
  'revision.author'?: string;
  'revision.email'?: string;
  'revision.subject'?: string;
  'revision.timestamp'?: number | Date;
  'revision.link'?: string;
  'ci.link'?: string;
  'timestamp'?: number
};
@vitalets vitalets linked a pull request Dec 19, 2024 that will close this issue
Open
@Skn0tt Skn0tt added the v1.50 label Dec 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
v1.50
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs: list fields allowed in metadata vitalets/playwright
2 participants
@vitalets @Skn0tt