Skip to content

[Testing] [Panther] Add component documentation #19109

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

Merged
merged 1 commit into from
Dec 7, 2023

Conversation

alexandre-daubois
Copy link
Member

Fix #12200

Had a quick chat with @OskarStark about adding complete documentation of Panther or not. As the README of the project is already full and well written, we thought it may deserve a mention in the Testing page rather than a full documentation page (which would only repeat the README after all)

@OskarStark
Copy link
Contributor

I talked to @dunglas before and he agrees with the documentation move

@alexandre-daubois alexandre-daubois marked this pull request as draft November 3, 2023 08:59
testing.rst Outdated

This is the purpose of `Panther`_, a library that provides a real browser
to run your tests. Here are a few things that make Panther special, compared
to other End to End testing tools:
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
to other End to End testing tools:
to other testing tools provided by Symfony:

Because most, if not all, E2E testing tools have the capabilities described below.

@alexandre-daubois alexandre-daubois changed the title [Testing] Mention Panther for E2E tests [Panther] Add component documentation Nov 3, 2023
@alexandre-daubois alexandre-daubois force-pushed the mention-panther branch 3 times, most recently from 32cdcf0 to 81e0c76 Compare November 3, 2023 13:28
@alexandre-daubois alexandre-daubois marked this pull request as ready for review November 3, 2023 13:28
@alexandre-daubois
Copy link
Member Author

The PR is ready 🙂 I took every topic of the README and integrated it. I also updated with your suggested changes @dunglas, thank you 👍

Panther works out of the box with `GitHub Actions`_.
Here is a minimal ``.github/workflows/panther.yaml`` file to run Panther tests:

.. code-block:: yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

@javiereguiluz WDYT ich we use a TAB directive here for the different CI systems?

@OskarStark
Copy link
Contributor

I think we should target 6.4 branch, because symfony/panther:5.4 will never exist 🤔

@alexandre-daubois alexandre-daubois force-pushed the mention-panther branch 2 times, most recently from 83f40a6 to 0d85418 Compare November 3, 2023 13:38
@alexandre-daubois alexandre-daubois changed the base branch from 5.4 to 6.4 November 3, 2023 13:38
@alexandre-daubois
Copy link
Member Author

Rebased on 6.4 👍

@OskarStark
Copy link
Contributor

@dunglas is this PR ready from your side?

Are you planing to move panther to Symfony 6.4 or later?

@javiereguiluz
Copy link
Member

@OskarStark I think that in 6.4/7.0 we can no longer make any changes because their release is imminent (3 weeks).

@carsonbot carsonbot changed the title [Panther] Add component documentation [Testing] [Panther] Add component documentation Dec 7, 2023
@javiereguiluz javiereguiluz modified the milestones: 5.4, 6.4 Dec 7, 2023
@javiereguiluz
Copy link
Member

This is finally merged 🥳 Alex, thanks a lot for this great contribution and for your patience during the review process.

@javiereguiluz javiereguiluz merged commit 76fd0be into symfony:6.4 Dec 7, 2023
@alexandre-daubois alexandre-daubois deleted the mention-panther branch December 7, 2023 13:28
@alexandre-daubois
Copy link
Member Author

Amazing! Thanks 🚀

@OskarStark
Copy link
Contributor

We would need a PR on the panther repo to link to the Symfony docs

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

Successfully merging this pull request may close these issues.

[Testing] Panther
5 participants