Setup Shopware

Setup Shopware in your GitHub Actions pipeline to run tests.

Usage

Inputs:

• env: The environment for Shopware. Should be test for PHPUnit or e2e for E2E tests. (default: test)
• shopware-version: The Shopware version to install. (required)
• shopware-repository: The Shopware repository to check out. (required, default: shopware/shopware)
• php-version: The PHP version to use. Can be any PHP version supported by setup-php. (default: 8.2)
• php-extensions: A comma-separated list of PHP extensions to install. See setup-php project (default: `")
• composer-root-version: The COMPOSER_ROOT_VERSION that should be set. Can be .auto to use the version from composer.json. (optional, default: .auto)
• install: Whether to install Shopware or not. If set to false, the action will only install PHP, MySQL, Composer packages. (required, default: false)
• install-locale: The locale to install Shopware with. (required, default: en-GB)
• install-currency: The currency to install Shopware with. (required, default: EUR)
• keep-composer-tools: Whether to keep Shopware Composer tools (PHP Stan, ECS/PHP-CS-Fixer, BC-Checker). (required, default: false)
• mysql-version: Specify any docker image to use instead of the bundled MySQL version of GitHub Actions (default: builtin)
• node-version: The Node.js version to use. Can be omitted if not needed. (optional, default: 20.x)
• install-admin: Whether to install Administration and build the assets. Can be omitted if not needed. (optional, default: "")
• install-storefront: Whether to install Storefront and build the assets. Can be omitted if not needed. (optional, default: "")
• path: Relative path under $GITHUB_WORKSPACE to place the Shopware repository. (required, default: "")

Example pipeline to run PHPUnit tests

jobs:
    phpunit:
        runs-on: ubuntu-latest
        steps:
            - name: Setup Shopware
              uses: shopware/setup-shopware@v1
              with:
                env: test
                shopware-version: v6.5.3.2
                shopware-repository: shopware/shopware
                php-version: 8.1
                install: true