Skip to content

Conversation

miliberlin
Copy link
Member

@miliberlin miliberlin commented Oct 15, 2025

Affected Components

  • CLI
  • Create CLI
  • Test
  • Docs
  • Examples
  • Other

Notes for the Reviewer

Summary

This PR updates all example projects to target the Danube Web Shop demo site (https://danube-web.shop) instead of Checkly's marketing site, improving the relevance and maintainability of example tests. It includes comprehensive test suite updates, project structure reorganization, configuration fixes, and documentation improvements.

Test Creation & Updates

Test Improvements:

  • Unified tests and folder structure across all examples projects to ensure quality
  • Replaced placeholder/empty test files with working examples
  • Updated Playwright-based checks to use consistent baseURL configuration from playwright.config or checkly.config

Configuration Updates

Playwright Config:

  • Updated baseURL across all projects to use Danube Web Shop
  • Enabled traces for all examples

Checkly Config:

  • Configured playwrightConfig with proper baseURL for browser and multistep checks

Dependencies:

  • Imported all required dependencies

Documentation Updates

All project READMEs updated with:

  • Accurate folder structure trees reflecting actual project organization
  • Correct file extensions (.js vs .ts) matching project type
  • Updated project descriptions mentioning Playwright Check Suites
  • Consistent documentation formatting across all examples

Cleanup

  • Removed unused .gitignore files from example projects (CLI will create this itself)
  • Removed empty or placeholder test files
  • Updated folder structure documentation to match actual files
  • Cleaned up non-existent file references

Resolves #[issue-number]

New Dependency Submission

Copy link
Member Author

Choose a reason for hiding this comment

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

was empty

Copy link
Member

Choose a reason for hiding this comment

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

@MariadeAnton was this intended?

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

@maxigimenez found another folder with more tests to tweak. Putting this back in draft. I think we are also not supposed to target the marketing page, right? I remember changing all the browser check templates at one point to go to https://welcome.checklyhq.com to reduce traffic and the influence on metrics. Should I replace that in the PW config and tweak the test to target that instead?

Copy link
Contributor

Choose a reason for hiding this comment

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

Let's do that, yes. We'll change that in the @stefanjudis examples as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

also empty

@miliberlin miliberlin marked this pull request as draft October 15, 2025 13:20
@miliberlin miliberlin marked this pull request as ready for review October 17, 2025 09:31
@miliberlin
Copy link
Member Author

@maxigimenez @MariadeAnton @ferrandiaz I think I fixed all issues with the PW templates that I found, let me know if there is more 🙏

@maxigimenez maxigimenez added the build Issue regarding building and packaging label Oct 20, 2025
@github-actions
Copy link

🎉 Experimental release successfully published on npm

npm install [email protected]

@miliberlin miliberlin changed the title feat: adjust PW example tests [tra-1519] refactor: example projects [tra-1519] Oct 21, 2025
Copy link
Member Author

Choose a reason for hiding this comment

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

The Checkly CLI automatically creates this when initiating a git repo. Let's keep it at that instead of having various versions in the codebase.

Copy link
Contributor

Choose a reason for hiding this comment

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

Great catch!

@miliberlin
Copy link
Member Author

@sorccu Do you have an idea why the test is failing? I only touched the examples which do not seem to be referenced in the E2E tests, so not sure if this is related to my changes.

@miliberlin
Copy link
Member Author

@MariadeAnton @maxigimenez I kind of opened pandoras box here. Sorry for the big PR but the examples were very neglected and all were slightly (or very) different from each other. Some weren't even working, missing crucial dependencies or using the outdated check group v1 construct which led to a big warning in the terminal. I tried to improve all these issues and ensure all tests pass. Also added additional comments to highlight difference between browser and Playwright checks.
I streamlined all examples projects to make it easier to make changes in the future and I checked that all examples work and all checks pass with:

npx checkly test --record
npx checkly pw-test
npx checkly deploy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build Issue regarding building and packaging

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants