[v11.0.x] Grafana E2E: Add deprecation notice and update docs #85778
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
![grafana-delivery-bot[bot]](https://avatars.githubusercontent.com/in/329617?s=60&v=4){kind=small}
* add deprecation notice * update docs * Update packages/grafana-e2e/README.md Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> --------- Co-authored-by: Jack Westbrook <jack.westbrook@gmail.com> (cherry picked from commit 0f1b65a)
grafana-delivery-bot
bot
requested review from
Clarity-89 and
JoaoSilvaGrafana
and removed request for
a team
grafana-delivery-bot
bot
requested review from
moxious and
tonypowa
and removed request for
a team
grafana-delivery-bot
bot
added
add to changelog
area/frontend
backport
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.
Backport 0f1b65a from #85619
What is this feature?
By the time G11 is released,
@grafana/plugin-e2ewill be generally available so we should deprecate the@grafana/e2epackage. The plan for phasing outgrafana/e2eis as follows:grafana/e2ereadme and update all docs referring tografana/e2eThis PR adds a deprecation notice and updates docs (step 1). This change will be communicated in the changelog, the release notes, community slack and (likely) in a blog post.
The style guide has three articles covering e2e testing - e2e.md, e2e-core.md and e2e-plugins.md. The e2e-plugins.md is now updated with relevant info. I made a few minor changes to the e2e and e2e-core docs, but feels like there are still a few things that are irrelevant, so it probably needs to be looked into by someone from the frontend platform. Pinging @ashharrison90 since I know you were involved in the migration from Cypress 9.
Who is this feature for?
Plugin authors
Which issue(s) does this PR fix?:
Part of #77484
Fixes #85625
Release notice breaking change
The
@grafana/e2epackage is deprecated in Grafana 11.0.0. If your Grafana plugin has end-to-end tests that use@grafana/e2e, it's recommended to replace them with@grafana/plugin-e2eand Playwright. For information on how to migrate, please refer to the plugin-e2e docs.