@@ -73,52 +73,60 @@ Use the branch that matches the phpBB version you're developing for.
7373
7474# # 🛠 Advanced Configuration Options
7575
76- You can fine-tune this workflow with several optional arguments :
77-
78- # # 🔃 Selectively Run Job Groups
79-
80- By default, all test job groups run. You can skip any by setting their arguments to 0 :
81-
82- ` ` ` yaml
83- with:
84- ...
85- RUN_BASIC_JOBS: 0 # Skip checks like sniffer, EPV, etc.
86- RUN_MYSQL_JOBS: 0 # Skip MySQL/MariaDB tests
87- RUN_POSTGRESQL_JOBS: 0 # Skip PostgreSQL tests
88- RUN_MSSQL_JOBS: 0 # Skip MSSQL and SQLite3 tests
89- ` ` `
90-
91- > 💡 Omit these inputs or set them to 1 to enable each group (default behavior).
92-
93- # # 📦 Install Dependencies
94-
95- If your extension relies on NPM or Composer dependencies, enable automated installs :
96-
97- ` ` ` yaml
98- with:
99- ...
100- RUN_NPM_INSTALL: 1 # Run ` npm ci`
101- RUN_COMPOSER_INSTALL : 1 # Run `composer install`
102- ` ` `
103-
104- > 💡 Omit if not needed.
105-
106- ## 🐘 Customise PHP Versions
107-
108- To override the default PHP versions tested (7.2 through 8.4), use:
76+ You can fine-tune this workflow with several optional arguments in the `with` section :
10977
11078` ` ` yaml
111- with :
112- ...
113- PRIMARY_PHP_VERSION : ' 8.1'
114- PHP_VERSION_MATRIX : ' ["8.0", "8.1", "8.2", "8.3", "8.4"]'
79+ call-tests:
80+ uses: phpbb-extensions/test-framework/.github/workflows/tests.yml@3.3.x
81+ with:
82+ EXTNAME: acme/demo # Your extension vendor/package name
83+ SNIFF: 1 # Run code sniffer on your code? 1 or 0
84+ IMAGE_ICC: 1 # Run icc profile sniffer on your images? 1 or 0
85+ EPV: 1 # Run EPV (Extension Pre Validator) on your code? 1 or 0
86+ EXECUTABLE_FILES: 1 # Run check for executable files? 1 or 0
87+ CODECOV: 0 # Run code coverage via codecov? 1 or 0
88+ PHPBB_BRANCH: 3.3.x # The phpBB branch to run tests on
89+
90+ # OPTIONAL ADVANCED CONFIGURATIONS BELOW
91+ # The following arguments are all optional and can be omitted if not needed.
92+
93+ # Set this to 0 to skip all basic checks (code sniffer, EPV, etc.)
94+ # Default: 1
95+ RUN_BASIC_JOBS: 1
96+
97+ # Set this to 0 to skip all MySQL/MariaDB tests.
98+ # Default: 1
99+ RUN_MYSQL_JOBS: 1
100+
101+ # Set this to 0 to skip all PostgreSQL tests.
102+ # Default: 1
103+ RUN_PGSQL_JOBS: 1
104+
105+ # Set this to 0 to skip all MSSQL and SQLite3 tests.
106+ # Default: 1
107+ RUN_MSSQL_JOBS: 1
108+
109+ # Set this to 1 if your extension relies on NPM dependencies.
110+ # Default: 0
111+ RUN_NPM_INSTALL: 0
112+
113+ # Set this to 1 if your extension relies on Composer dependencies.
114+ # Default: 0
115+ RUN_COMPOSER_INSTALL: 0
116+
117+ # CUSTOMISE PHP VERSIONS
118+ # To override the default PHP versions tested (7.2 through 8.4):
119+
120+ # Preferred PHP version used for all test jobs.
121+ # Default: '7.2'
122+ PRIMARY_PHP_VERSION: '7.2'
123+
124+ # The MySQL and PostgreSQL jobs run tests across multiple PHP versions.
125+ # List the PHP versions you want your extension tested with.
126+ # Default: '["7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3", "8.4"]'
127+ PHP_VERSION_MATRIX: '["7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3", "8.4"]'
115128` ` `
116129
117- - ` PRIMARY_PHP_VERSION`: PHP version used for all jobs, including checks and MSSQL. Default is 7.2.
118- - `PHP_VERSION_MATRIX` : List of all PHP versions you want tested (in MySQL and PostgreSQL jobs).
119-
120- > 💡 Use this if your extension supports a limited or newer PHP version range. Omit if not needed.
121-
122130# # 📊 Code Coverage with Codecov
123131
124132This test framework supports code coverage reporting through [Codecov.io](https://codecov.io). To enable it, follow these steps :
0 commit comments