Contao Build Tools Laravel Package

Product Decisions This Supports

• Standardization of Contao Development Workflows: Adopt a unified, opinionated build toolchain to enforce coding standards (PHPStan, PHP-CS-Fixer, Rector) and CSS linting (Stylelint) across Contao projects, reducing technical debt and onboarding friction for new developers.
• Accelerated CI/CD Pipeline Setup: Leverage pre-configured GitHub Actions workflows to streamline CI/CD for Contao, reducing setup time and maintenance overhead compared to custom scripts.
• Deployment Automation for Contao: Integrate Deployer to automate Contao website deployments, minimizing manual errors and deployment time, particularly valuable for teams managing multiple Contao instances.
• Alignment with Symfony Best Practices: Adopt Symfony’s directory structure (src/) and conventions for Contao projects, improving code organization and maintainability while aligning with broader PHP ecosystem standards.
• Build vs. Buy Decision: Justify adopting this package over custom tooling if the team lacks DevOps bandwidth or Contao expertise, as it provides "batteries included" for Contao-specific workflows without reinventing the wheel.
• Roadmap for Contao-Specific Tooling: Use this as a foundation to extend or customize the toolchain (e.g., adding Twig-CS-Fixer or dependency checks) to meet evolving Contao ecosystem needs.

When to Consider This Package

• Contao-Specific Projects: Only relevant for Contao-based applications or extensions. Avoid if the project is Laravel, Symfony (non-Contao), or another PHP framework.
• Symfony Best Practices Adoption: Ideal for teams willing to adopt Symfony’s src/ directory structure and conventions for Contao projects. Not suitable for legacy Contao setups or teams resistant to opinionated tooling.
• Early-Stage or Experimental Use: Marked as "DO NOT USE IN PRODUCTION," this package is best suited for internal tooling, pilot projects, or teams comfortable with experimental dependencies.
• Limited DevOps Resources: Teams lacking DevOps expertise or time to configure CI/CD pipelines from scratch will benefit from the pre-configured GitHub Action and Deployer integration.
• Need for Contao-Specific Tooling: If the team requires Contao-tailored code quality tools (e.g., PHPStan rules for Contao models, Rector presets for Contao upgrades), this package provides a starting point.
• Avoid If:
  • The project is not Contao-based (e.g., Laravel, WordPress, or generic PHP).
  • The team prefers custom tooling or deviates from Symfony best practices (e.g., non-src/ directory structure).
  • Stability is critical, as the package is experimental with no production-grade guarantees.
  • The team needs frontend asset optimization (e.g., Webpack, Vite) or database migration tools, which are not included.

How to Pitch It (Stakeholders)

For Executives: "This package standardizes our Contao development workflows, reducing bugs and deployment time by automating code quality checks (PHPStan, Rector) and CI/CD pipelines. It’s like ‘Symfony Flex for Contao’—cutting setup time by 50% while enforcing best practices. The experimental nature means low risk for production, but high upside for long-term maintainability and developer productivity. Ideal for teams managing multiple Contao sites or lacking DevOps resources."

For Engineering: *"This toolkit provides a pre-configured, Contao-specific setup for:

• Code Quality: PHPStan, PHP-CS-Fixer, and Rector (with Contao-specific rules) to catch issues early.
• CI/CD: A ready-to-use GitHub Action workflow for Contao, reducing pipeline configuration time.
• Deployments: Deployer integration for zero-downtime Contao updates, cutting manual deployment steps.

It’s opinionated but saves weeks of tooling setup. We can customize configs (e.g., ecs.php, phpstan.neon) to fit our needs. Start with a pilot project to validate before wider adoption. For non-Contao projects, we’ll need standalone alternatives like laravel-pint or phpstan/laravel."*