CI/CD Configuration

This document describes the Continuous Integration and Continuous Deployment (CI/CD) configuration used in the QueryTranslator library. It focuses specifically on the automated testing workflows implemented through GitHub Actions. For information about the test suite structure and running tests locally, see Test Suite.

Overview

The QueryTranslator library uses GitHub Actions to automatically run tests whenever code changes are pushed to the repository. This ensures that all code changes maintain the expected functionality and don't introduce regressions.

GitHub Actions Workflow

The CI pipeline is defined in the .github/workflows/tests.yml file and is triggered on:

• Pushes to the master branch
• Any pull request

Workflow Visualization

Sources: .github/workflows/tests.yml2-37

PHP Version Matrix

The CI configuration uses a matrix strategy to test the codebase against multiple PHP versions simultaneously:

PHP Version	Tested
7.0	Yes
7.1	Yes
7.2	Yes
7.3	Yes
7.4	Yes
8.0	Yes
8.1	Yes
8.2	Yes
8.3	Yes

This matrix approach ensures that the library maintains compatibility across a wide range of PHP versions, from PHP 7.0 all the way to the latest PHP 8.3.

Sources: .github/workflows/tests.yml11-23

Workflow Steps

1. Environment Setup

The workflow begins by checking out the code and setting up the PHP environment with the specified version and Xdebug for code coverage:

• Uses GitHub's actions/checkout@v2 action to clone the repository
• Uses shivammathur/setup-php@v2 action to set up PHP with the version from the matrix
• Enables Xdebug for code coverage generation

Sources: .github/workflows/tests.yml25-29

2. Dependency Management

The workflow then handles dependencies using Composer:

• Configures a GitHub OAuth token to avoid API rate limits when fetching dependencies
• Validates the composer.json file for correctness with --strict option to ensure highest quality
• Updates all dependencies using composer update --prefer-dist to use cached packages when possible

Sources: .github/workflows/tests.yml31-34

3. Testing and Coverage

Finally, the workflow runs tests and handles code coverage:

• Executes PHPUnit tests from the vendor directory using the phpunit.xml configuration
• Generates a code coverage report in Clover XML format
• Uploads the coverage report to Codecov using their bash uploader script

Sources: .github/workflows/tests.yml35-36

Codecov Integration

The workflow integrates with Codecov to track code coverage over time. This helps maintain and improve test coverage by making it visible how code changes affect the overall test coverage. The coverage data is uploaded with the flag all to indicate it covers the entire codebase.

Sources: .github/workflows/tests.yml36

Failure Handling

The workflow is configured with fail-fast: false, which means that if a job fails for one PHP version, the other jobs will continue running. This approach provides maximum information about compatibility issues across different PHP versions in a single run.

Sources: .github/workflows/tests.yml12-13

Role in Development Workflow

The CI/CD configuration plays a crucial role in the development workflow of QueryTranslator:

1. Quality Assurance: Automatically verifies that all code changes pass tests across multiple PHP versions
2. Backward Compatibility: Ensures the library maintains compatibility with PHP 7.0 and above
3. Contributor Confidence: Gives contributors immediate feedback on whether their changes maintain expected functionality
4. Code Coverage Monitoring: Tracks test coverage to identify areas that need additional testing
5. Pull Request Validation: Provides automated checks that help maintainers evaluate pull requests

This automated testing infrastructure allows the development team to move quickly while maintaining code quality and compatibility.

Sources: .github/workflows/tests.yml1-37