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

Improve docs on phpunit version #205

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -317,7 +317,9 @@ Mautic uses [PHPUnit][php-unit] and [Selenium][selenium] as the suite of testing

#### PHPUnit

Before executing unit tests, copy the `.env.dist` file to `.env` then update to reflect your local environment configuration.
**PHPUnit version:** Mautic 4.x requires [PHPUnit v5.7](https://phpunit.de/manual/5.7/en/installation.html), and Mautic 5.x requires [PHPUnit v9+](https://phpunit.de/announcements/phpunit-9.html). Make sure to install the right version of PHPUnit for the version of Mautic you are testing.
Copy link
Sponsor Member

Choose a reason for hiding this comment

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

Could you please make these into link macros, as used in the rest of the doc and listed below at the bottom of the page? Thanks!


**Mautic 4.x:** Before executing unit tests, copy the `.env.dist` file to `.env` then update to reflect your local environment configuration. Mautic 5.x includes an 'env.test' file which is used for unit tests - edit this with your database information if needed.

**Running functional tests without setting the .env file with a different database results in the configured database being overwritten.**

Expand Down Expand Up @@ -348,7 +350,7 @@ Mautic can't have PHPSTAN as its dev dependency, because it requires PHP7+. To r
[mautic-contributors-agreement]: <https://www.mautic.org/contributor-agreement>
[symfony-coding-standards]: <http://symfony.com/doc/current/contributing/code/standards.html>
[php-cs-fixer]: <https://github.com/friendsofphp/php-cs-fixer>
[php-unit]: <https://phpunit.de/manual/5.7/en/index.html>
[php-unit]: <https://phpunit.de/getting-started/phpunit-10.html>
[symfony-functional-tests]: <https://symfony.com/doc/2.8/testing.html>
[mautic-docs]: <https://github.com/mautic/documentation>
[developer-docs]: <https://developer.mautic.org/>
Expand Down