Skip to content

Commit 0a28cce

Browse files
author
Greg Bowler
committed
Document versions
1 parent 74f6a41 commit 0a28cce

File tree

1 file changed

+16
-6
lines changed

1 file changed

+16
-6
lines changed

README.md

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,9 @@ The following configuration options are available:
4242
+ `log_junit` Path to junit output file (default: `test/phpunit/_junit/junit.xml`)
4343
+ `memory_limit` The memory limit to run your tests with (default: `512M`)
4444
+ `bootstrap` The path to the bootstrap file (default: `vendor/autoload.php`)
45+
+ `version` The version of PHPUnit to use e.g. `9` or `9.5.0` (default: latest)
4546
+ `php_version` The version of PHP to use e.g. `7.4` (default: latest)
46-
+ `phpunit_version` The version of PHPUnit to use e.g. `9` or `9.5.0` (default: latest)
47+
+ `php_extensions` Space-separated list of extensions using [php-build][php-build] e.g. `xdebug mbstring` (default: N/A)
4748

4849
The syntax for passing in a custom input is the following:
4950

@@ -64,17 +65,26 @@ jobs:
6465
6566
If you require other configurations of phpunit, please request them in the [Github issue tracker](https://github.com/php-actions/phpunit/issues)
6667
67-
Versions
68-
--------
68+
PHP and PHPUnit versions
69+
------------------------
6970
70-
Previously, the Github Actions release version numbers were in sync with the PHPUnit version, but this imposed too many limitations. For the next 12 months, v7, v8 and v9 branches will still point to their existing commits, but we have reverted to v1-based Actions releases, allowing PHPUnit version number to be specified from your configuration, using the `phpunit_version` input variable.
71+
It's possible to run any version of PHPUnit under any version of PHP, with any PHP extensions you require. This is configured with the following inputs:
7172
72-
Any PHPUnit version available from https://phar.phpunit.de/ are supported.
73+
+ `version` - the version number of PHPUnit to run e.g. `9` or `9.5.0` (default: latest)
74+
+ `php_version` - the version number of PHP to use e.g. `7.4` (default: latest)
75+
+ `php_extensions` - a space-separated list of extensions to install using [php-build][php-build] e.g. `xdebug mbstring` (default: N/A)
7376

74-
Please note the version number specified within your Action configuration must match your composer.json major version number. For example, if your composer.json requires `phpunit/phpunit 8.5.8`, you must use `phpunit_version: 8.5.8`, as major versions of PHPUnit are incompatible with each other.
77+
Please note the version number specified within your Action configuration must match your `composer.json` major version number. For example, if your composer.json requires `phpunit/phpunit 8.5.8`, you must use the `version: 8.5.8` input, as major versions of PHPUnit are incompatible with each other.
7578

7679
If you require a specific version that is not compatible with Github Actions for some reason, please make a request in the [Github issue tracker](https://github.com/php-actions/phpunit/issues).
7780

81+
Github Actions releases
82+
-----------------------
83+
84+
Previously, the Github Actions release version numbers were in sync with the PHPUnit version, but this imposed too many limitations. For the next 12 months (until 30th November 2021), v7, v8 and v9 branches will still point to their existing commits, but we have reverted to v1-based Actions releases, allowing PHPUnit version number to be specified from your configuration, using the `version` input variable.
85+
86+
***
87+
7888
If you found this repository helpful, please consider [sponsoring the developer][sponsor].
7989

8090
[sponsor]: https://github.com/sponsors/g105b

0 commit comments

Comments
 (0)