GH Actions: run tests against PHP 8.1 and other tweaks #172
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
... use `ubuntu-18.04` or `ubuntu-latest` for `20.04` instead. Also see: * https://ubuntu.com/blog/ubuntu-16-04-lts-transitions-to-extended-security-maintenance-esm * shivammathur/setup-php#452
As no code coverage is being recorded for these builds, it is good practice to explicitly set `coverage: none` in `setup-php`. This fixes a warning on PHP 5.3 stating that Xdebug is on.
... by using the `ramsey/composer-install` action. This means that the Composer downloads directory for dependencies will be cached and restored on each build. This conserves resources and should also make builds faster. Ref: https://github.com/marketplace/actions/install-composer-dependencies
Psalm does not need to be run against multiple PHP versions. Running it once should be enough. With that in mind, this commit: * Introduces a separate, dedicated workflow which only installs and runs Psalm. * Removes the Psalm related steps from the `CI` workflow. * Removes Psalm from the `tools` setting for `setup-php`.
In contrast to Sodium Compat, the tests for this package _were_ running on the low PHP versions. However, the point remains that PHPUnit was being installed 3 (!) times, once via the `setup-php` action, once via the `composer install` and once via the `php-actions/phpunit` action. This simplifies the script and ensures that the tests are always run against the most appropriate PHPUnit version for the PHP version against which the tests are being run, by: * Remove the installing of PHPUnit via `setup-php`. * Remove the use of the `php-actions/phpunit` action. * Defer to the Composer installed PHPUnit version in all cases. I'm also removing the explicit ini settings for the jobs. These look like they were copied over from example code, but these values don't have any effect on the test runs in these workflows, so may as well be removed.
As there is now effectively no difference anymore between the `moderate` and `modern` jobs, these jobs can now be merged into one.
The default setting for `error_reporting` used by the SetupPHP action is `error_reporting=E_ALL & ~E_DEPRECATED & ~E_STRICT` and `display_errors` is set to `Off`. For the purposes of CI, I'd recommend running with `E_ALL` and `display_errors=On` to ensure **all** PHP notices are shown. Ref: shivammathur/setup-php#469
For now, this build is still allowed to fail.
|
massive description! 🙇♂️ |
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.
This is largely the same PR as pulled in paragonie/sodium_compat#135
Commit details
GH Actions: ubuntu-16.04 is no longer supported
... use
ubuntu-18.04orubuntu-latestfor20.04instead.Also see:
GH Actions: explicitly set code coverage to none
As no code coverage is being recorded for these builds, it is good practice to explicitly set
coverage: noneinsetup-php.This fixes a warning on PHP 5.3 stating that Xdebug is on.
GH Actions: enable Composer caching
... by using the
ramsey/composer-installaction.This means that the Composer downloads directory for dependencies will be cached and restored on each build. This conserves resources and should also make builds faster.
Ref: https://github.com/marketplace/actions/install-composer-dependencies
GH Actions: split off Psalm to separate workflow
Psalm does not need to be run against multiple PHP versions. Running it once should be enough.
With that in mind, this commit:
CIworkflow.toolssetting forsetup-php.GH Actions: clean up running of the tests
In contrast to Sodium Compat, the tests for this package were running on the low PHP versions.
However, the point remains that PHPUnit was being installed 3 (!) times, once via the
setup-phpaction, once via thecomposer installand once via thephp-actions/phpunitaction.This simplifies the script and ensures that the tests are always run against the most appropriate PHPUnit version for the PHP version against which the tests are being run, by:
setup-php.php-actions/phpunitaction.I'm also removing the explicit ini settings for the jobs.
These look like they were copied over from example code, but these values don't have any effect on the test runs in these workflows, so may as well be removed.
GH Actions: merge "moderate" and "modern" jobs
As there is now effectively no difference anymore between the
moderateandmodernjobs, these jobs can now be merged into one.GH Actions: set error reporting to -1
The default setting for
error_reportingused by the SetupPHP action iserror_reporting=E_ALL & ~E_DEPRECATED & ~E_STRICTanddisplay_errorsis set toOff.For the purposes of CI, I'd recommend running with
-1anddisplay_errors=Onto ensure all PHP notices are shown.Ref: shivammathur/setup-php#469
GH Actions: enable testing against PHP 8.1
For now, this build is still allowed to fail.