Package Configuration - pipeline

The pipeline section consists of the limitations that must be met for the CI pipeline to mark a run as successful, hence allowing the commit to be automatically synced to other servers such as the production server. Below explains all elements within this section.

phpunit

Defines what constitutes a successful run of all phpUnit tests, and can be one of the following values:

• off - Don't run or check phpUnit tests at all.
• strict - Must pass all phpUnit tests with no errors or warnings.
• flex - The phpUnit tests must not return any errors, but may return warnings.

phpStan

The phpstan element consists of two child elements which are explained below:

• level - The level between 0 - 10 that will be checked, and must return without any errors to be considered successful.
• fail_on_ignoreable - phpStan will always state whether or not the error is ignoreable. This is a boolean that defines whether or not the test should fail if ignoreable errors are encountered.

phpCs

The phpcs element consists of two child elements, which are:

• severity - Level between 0 - 10 that must be met without any errors to be considered a successful run.
• fail_on_warning - Aside from just errors, phpCs will always provide warnings. This is a boolean as to whether or not the run should fail due to warnings being present.

View Test Results

After every commit the CI pipeline will run through all tests, and if unsuccessful will send you an e-mail with the results. You may also access all test results by viewing the repository within your web browser at https://code.apepxl.io/<AUTHOR>/<PACKAGE>/.

Once there, visit the "Revisions" tab, and click on any desired revision number you wish to view. The following page will contain a tab control containing basic information, all files updated / delete, plus a tab consisting of the CI pipeline test results.