-
-
Notifications
You must be signed in to change notification settings - Fork 6
177 lines (147 loc) · 6.95 KB
/
test.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
name: Test
on:
# Run on pushes to `stable` and on all pull requests.
push:
branches:
- stable
pull_request:
# Allow manually triggering the workflow.
workflow_dispatch:
# Cancels all previous workflow runs for the same branch that have not yet completed.
concurrency:
# The concurrency group contains the workflow name and the branch name.
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
jobs:
#### TEST STAGE ####
test:
runs-on: ubuntu-latest
strategy:
# Keys:
# - experimental: Whether the build is "allowed to fail".
matrix:
# IMPORTANT: test runs shouldn't fail because of PHPCS being incompatible with a PHP version.
# - PHPCS will run without errors on PHP 5.4 - 7.2 on any version.
# - PHP 7.3 needs PHPCS 3.3.1+ to run without errors.
# - PHP 7.4 needs PHPCS 3.5.0+ to run without errors.
# - PHP 8.0 needs PHPCS 3.5.7+ to run without errors.
# - PHP 8.1 needs PHPCS 3.6.1+ to run without errors.
# - PHP 8.2 needs PHPCS 3.6.1+ to run without errors.
# - PHP 8.3 needs PHPCS 3.8.0+ to run without errors (though the errors don't affect this package).
# - PHP 8.4 needs PHPCS 3.8.0+ to run without errors (officially 3.11.0, but 3.8.0 will work fine).
php: ['5.4', '5.5', '5.6', '7.0', '7.1', '7.2']
phpcs_version: ['3.1.0', 'dev-master']
include:
# Complete the matrix, while preventing issues with PHPCS versions incompatible with certain PHP versions.
- php: '8.4'
phpcs_version: 'dev-master'
- php: '8.4'
phpcs_version: '3.8.0'
- php: '8.3'
phpcs_version: 'dev-master'
- php: '8.3'
phpcs_version: '3.8.0'
- php: '8.2'
phpcs_version: 'dev-master'
- php: '8.2'
phpcs_version: '3.6.1'
- php: '8.1'
phpcs_version: 'dev-master'
- php: '8.1'
phpcs_version: '3.6.1'
- php: '8.0'
phpcs_version: 'dev-master'
- php: '8.0'
phpcs_version: '3.5.7'
- php: '7.4'
phpcs_version: 'dev-master'
- php: '7.4'
phpcs_version: '3.5.0'
- php: '7.3'
phpcs_version: 'dev-master'
- php: '7.3'
phpcs_version: '3.3.1'
# Experimental builds. These are allowed to fail.
- php: '7.4'
phpcs_version: '4.0.x-dev'
- php: '8.5' # Nightly.
phpcs_version: 'dev-master'
name: "Test${{ matrix.phpcs_version == 'dev-master' && ' + Lint' || '' }}: PHP ${{ matrix.php }} - PHPCS ${{ matrix.phpcs_version }}"
continue-on-error: ${{ matrix.php == '8.5' || matrix.phpcs_version == '4.0.x-dev' }}
steps:
- name: Checkout code
uses: actions/checkout@v4
# Updating the lists can fail intermittently, typically after Microsoft has released a new package.
# This should not be blocking for this job, so ignore any errors from this step.
# Ref: https://github.com/dotnet/core/issues/4167
- name: Update the available packages list
continue-on-error: true
run: sudo apt-get update
- name: Install xmllint
run: sudo apt-get install --no-install-recommends -y libxml2-utils
- name: Setup ini config
id: set_ini
run: |
# On stable PHPCS versions, allow for PHP deprecation notices.
# Unit tests don't need to fail on those for stable releases where those issues won't get fixed anymore.
if [[ "${{ matrix.phpcs_version }}" != "dev-master" && "${{ matrix.phpcs_version }}" != "4.0.x-dev" ]]; then
echo 'PHP_INI=error_reporting=E_ALL & ~E_DEPRECATED, display_errors=On' >> "$GITHUB_OUTPUT"
else
echo 'PHP_INI=error_reporting=-1, display_errors=On' >> "$GITHUB_OUTPUT"
fi
- name: Install PHP
uses: shivammathur/setup-php@v2
with:
php-version: ${{ matrix.php }}
ini-values: ${{ steps.set_ini.outputs.PHP_INI }}
coverage: none
tools: cs2pr
- name: 'Composer: adjust dependencies'
run: |
# Set the PHPCS version to be used in the tests.
composer require --no-update squizlabs/php_codesniffer:"${{ matrix.phpcs_version }}" --no-scripts --no-interaction
# Remove the PHPCSDevCS dependency as it has different PHPCS requirements and would block installs.
composer remove --no-update --dev phpcsstandards/phpcsdevcs --no-scripts --no-interaction
# Install dependencies and handle caching in one go.
# @link https://github.com/marketplace/actions/install-php-dependencies-with-composer
- name: Install Composer dependencies - normal
if: ${{ matrix.php < 8.5 }}
uses: "ramsey/composer-install@v3"
with:
# Bust the cache at least once a month - output format: YYYY-MM.
custom-cache-suffix: $(date -u "+%Y-%m")
# For PHP "nightly", we need to install with ignore platform reqs as not all dependencies allow installation.
- name: Install Composer dependencies - with ignore platform
if: ${{ matrix.php >= 8.5 }}
uses: "ramsey/composer-install@v3"
with:
composer-options: --ignore-platform-reqs
custom-cache-suffix: $(date -u "+%Y-%m")
- name: Lint against parse errors (PHP 7.2+)
if: ${{ matrix.phpcs_version == 'dev-master' && matrix.php >= '7.2' }}
run: composer lint -- --checkstyle | cs2pr
- name: Lint against parse errors (PHP < 7.2)
if: ${{ matrix.phpcs_version == 'dev-master' && matrix.php < '7.2' }}
run: composer lintlt72 -- --checkstyle | cs2pr
# Check that any sniffs available are feature complete.
# This also acts as an integration test for the feature completeness script,
# which is why it is run against various PHP versions and not in the "Sniff" stage.
- name: Check for feature completeness
if: matrix.phpcs_version == 'dev-master'
run: composer check-complete
- name: Grab PHPUnit version
id: phpunit_version
run: echo "VERSION=$(vendor/bin/phpunit --version | grep --only-matching --max-count=1 --extended-regexp '\b[0-9]+\.[0-9]+')" >> "$GITHUB_OUTPUT"
- name: Determine PHPUnit composer script to use
id: phpunit_script
run: |
if [ "${{ startsWith( steps.phpunit_version.outputs.VERSION, '10.' ) || startsWith( steps.phpunit_version.outputs.VERSION, '11.' ) }}" == "true" ]; then
echo 'SUFFIX=' >> "$GITHUB_OUTPUT"
else
echo 'SUFFIX=-lte9' >> "$GITHUB_OUTPUT"
fi
- name: Run the unit tests for the PHPCSDebug sniff
run: composer test-sniff${{ steps.phpunit_script.outputs.SUFFIX }}
- name: Run the unit tests for the DevTools
if: ${{ matrix.phpcs_version == 'dev-master' }}
run: composer test-tools${{ steps.phpunit_script.outputs.SUFFIX }}