Skip to content

Commit b913e2b

Browse files
committed
Update readme
1 parent 093cdf3 commit b913e2b

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,28 @@ jobs:
6363
- Your extension must follow standard phpBB extension structure.
6464
- Tests must be defined in your repository using PHPUnit.
6565
66+
## ⏭️ Skipping Jobs
67+
68+
This test framework runs four primary job groups:
69+
1. Basic checks - These are the code sniffer, icc profile sniffer, executable file and EPV checks.
70+
2. MySQL - Tests using MySQL and MariaDB database structures.
71+
3. PostgreSQL - Tests using PostgreSQL database structures.
72+
4. MSSQL - Tests using MSSQL and SQLite3 database structures.
73+
74+
You can skip any of these job groups—such as if your extension does not support MSSQL—by setting the appropriate arguments when using this workflow:
75+
76+
```yaml
77+
with:
78+
...
79+
RUN_BASIC_JOBS: 1 # Set to 0 to skip; otherwise set to 1 or omit
80+
RUN_MYSQL_JOBS: 1 # Set to 0 to skip; otherwise set to 1 or omit
81+
RUN_POSTGRESQL_JOBS: 1 # Set to 0 to skip; otherwise set to 1 or omit
82+
RUN_MSSQL_JOBS: 0 # Set to 0 to skip; otherwise set to 1 or omit
83+
...
84+
```
85+
86+
> Note: If you do not need to skip any jobs, you don’t need to include these arguments at all. For example, omitting `RUN_BASIC_JOBS` is equivalent to setting it to 1. You only need to define these arguments if you want to disable a job by setting its value to 0.
87+
6688
## 📊 Code Coverage with Codecov
6789

6890
This test framework supports code coverage reporting through [Codecov.io](https://codecov.io). To enable it, follow these steps:

0 commit comments

Comments
 (0)