feat: align plugin and pipeline with Shopware guidelines #13
No files matched your search
@@ -11,6 +11,11 @@ on:
|
|||||||
permissions:
|
permissions:
|
||||||
contents: read
|
contents: read
|
||||||
|
|
||||||
|
# A new push to the PR cancels the superseded run.
|
||||||
|
concurrency:
|
||||||
|
group: plugin-checks-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
# Packages the extension (builds admin/storefront assets) and validates the resulting zip,
|
# Packages the extension (builds admin/storefront assets) and validates the resulting zip,
|
||||||
# which is the artifact that ships. A separate directory validate would only repeat these checks.
|
# which is the artifact that ships. A separate directory validate would only repeat these checks.
|
||||||
@@ -35,6 +40,16 @@ jobs:
|
|||||||
run: shopware-cli extension validate .build/package.zip
|
run: shopware-cli extension validate .build/package.zip
|
||||||
- name: Assert built JS is in the zip
|
- name: Assert built JS is in the zip
|
||||||
run: scripts/ci/assert-built-assets.sh .build/package.zip
|
run: scripts/ci/assert-built-assets.sh .build/package.zip
|
||||||
|
# The release workflow reuses this tested zip when main ends up with the same tree
|
||||||
|
# (it falls back to packaging again otherwise).
|
||||||
|
- name: Tree hash of the packaged commit
|
||||||
|
id: tree
|
||||||
|
run: echo "hash=$(git rev-parse "${GITHUB_SHA}^{tree}")" >> "$GITHUB_OUTPUT"
|
||||||
|
- name: Save tested zip for the release
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: .build/package.zip
|
||||||
|
key: plugin-zip-${{ steps.tree.outputs.hash }}
|
||||||
|
|
||||||
phpunit:
|
phpunit:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
@@ -51,21 +66,36 @@ jobs:
|
|||||||
DATABASE_URL: mysql://root:root@database:3306/shopware
|
DATABASE_URL: mysql://root:root@database:3306/shopware
|
||||||
APP_ENV: test
|
APP_ENV: test
|
||||||
APP_URL: http://localhost
|
APP_URL: http://localhost
|
||||||
|
APP_SECRET: ci-secret-not-for-production
|
||||||
|
INSTANCE_ID: ci
|
||||||
COMPOSER_MEMORY_LIMIT: '-1'
|
COMPOSER_MEMORY_LIMIT: '-1'
|
||||||
COMPOSER_ALLOW_SUPERUSER: '1'
|
COMPOSER_ALLOW_SUPERUSER: '1'
|
||||||
steps:
|
steps:
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
path: plugin-src
|
path: plugin-src
|
||||||
- uses: actions/cache@v4
|
- name: Month stamp (refreshes the cached project monthly)
|
||||||
|
id: stamp
|
||||||
|
run: echo "month=$(date +%Y-%m)" >> "$GITHUB_OUTPUT"
|
||||||
|
# The project (incl. vendor/ and phpunit) does not depend on the plugin, so it is cached on its own.
|
||||||
|
- name: Restore prepared Shopware project
|
||||||
|
id: project
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
with:
|
with:
|
||||||
path: |
|
path: shopware
|
||||||
~/.cache/composer
|
key: shopware-6.6-prepared-${{ steps.stamp.outputs.month }}
|
||||||
~/.composer/cache
|
- name: Create Shopware 6.6 project
|
||||||
key: composer-${{ runner.os }}-shopware-6.6-${{ hashFiles('plugin-src/composer.json') }}
|
if: steps.project.outputs.cache-hit != 'true'
|
||||||
restore-keys: composer-${{ runner.os }}-shopware-6.6-
|
run: |
|
||||||
- name: Toolchain
|
set -e
|
||||||
run: php -v && composer --version && php -m | tr '\n' ' '
|
composer create-project shopware/production:6.6.* shopware --no-interaction --no-scripts
|
||||||
|
composer require --dev phpunit/phpunit:^10 --no-interaction --no-scripts -d shopware
|
||||||
|
- name: Save prepared Shopware project
|
||||||
|
if: steps.project.outputs.cache-hit != 'true'
|
||||||
|
uses: actions/cache/save@v4
|
||||||
|
with:
|
||||||
|
path: shopware
|
||||||
|
key: shopware-6.6-prepared-${{ steps.stamp.outputs.month }}
|
||||||
- name: Wait for the database
|
- name: Wait for the database
|
||||||
run: |
|
run: |
|
||||||
for i in $(seq 60); do
|
for i in $(seq 60); do
|
||||||
@@ -73,22 +103,19 @@ jobs:
|
|||||||
sleep 2
|
sleep 2
|
||||||
done
|
done
|
||||||
echo "::error::database service did not come up"; exit 1
|
echo "::error::database service did not come up"; exit 1
|
||||||
- name: Resolve plugin name
|
- name: Relax database durability (throwaway CI database, speeds up the migrations)
|
||||||
|
run: |
|
||||||
|
php -r '$p = new PDO("mysql:host=database;port=3306", "root", "root"); $p->exec("SET GLOBAL innodb_flush_log_at_trx_commit=0"); $p->exec("SET GLOBAL sync_binlog=0");'
|
||||||
|
- name: Resolve plugin name and install the plugin sources
|
||||||
run: |
|
run: |
|
||||||
# plugin directory name = short class name of extra.shopware-plugin-class
|
# plugin directory name = short class name of extra.shopware-plugin-class
|
||||||
CLASS=$(php -r 'echo json_decode(file_get_contents("plugin-src/composer.json"), true)["extra"]["shopware-plugin-class"];')
|
CLASS=$(php -r 'echo json_decode(file_get_contents("plugin-src/composer.json"), true)["extra"]["shopware-plugin-class"];')
|
||||||
echo "PLUGIN_NAME=${CLASS##*\\}" >> "$GITHUB_ENV"
|
PLUGIN_NAME="${CLASS##*\\}"
|
||||||
- name: Create Shopware 6.6 project
|
echo "PLUGIN_NAME=${PLUGIN_NAME}" >> "$GITHUB_ENV"
|
||||||
run: composer create-project shopware/production:6.6.* shopware --no-interaction --no-scripts
|
rm -rf "shopware/custom/plugins/${PLUGIN_NAME}"
|
||||||
- name: Install Shopware and the plugin
|
cp -r plugin-src "shopware/custom/plugins/${PLUGIN_NAME}"
|
||||||
working-directory: shopware
|
# No system:install / plugin:install: Shopware's TestBootstrapper builds its own test database and
|
||||||
run: |
|
# installs the plugin (tests/TestBootstrap.php), so doing it here ran every migration twice.
|
||||||
set -e
|
|
||||||
composer require --dev phpunit/phpunit:^10 --no-interaction
|
|
||||||
bin/console system:install --basic-setup --create-database --force --no-interaction
|
|
||||||
cp -r ../plugin-src "custom/plugins/${PLUGIN_NAME}"
|
|
||||||
bin/console plugin:refresh
|
|
||||||
bin/console plugin:install --activate "${PLUGIN_NAME}"
|
|
||||||
- name: Run phpunit
|
- name: Run phpunit
|
||||||
working-directory: shopware
|
working-directory: shopware
|
||||||
run: vendor/bin/phpunit -c "custom/plugins/${PLUGIN_NAME}/phpunit.xml"
|
run: vendor/bin/phpunit -c "custom/plugins/${PLUGIN_NAME}/phpunit.xml"
|
||||||
@@ -49,8 +49,22 @@ jobs:
|
|||||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
- uses: actions/cache@v4
|
# Reuse the zip the PR workflow already built and tested for this exact tree.
|
||||||
|
- name: Tree hash of this commit
|
||||||
if: steps.meta.outputs.skip == 'false'
|
if: steps.meta.outputs.skip == 'false'
|
||||||
|
id: tree
|
||||||
|
run: echo "hash=$(git rev-parse "${GITHUB_SHA}^{tree}")" >> "$GITHUB_OUTPUT"
|
||||||
|
|
||||||
|
- name: Restore the tested zip from the PR run
|
||||||
|
if: steps.meta.outputs.skip == 'false'
|
||||||
|
id: prebuilt
|
||||||
|
uses: actions/cache/restore@v4
|
||||||
|
with:
|
||||||
|
path: .build/package.zip
|
||||||
|
key: plugin-zip-${{ steps.tree.outputs.hash }}
|
||||||
|
|
||||||
|
- uses: actions/cache@v4
|
||||||
|
if: steps.meta.outputs.skip == 'false' && steps.prebuilt.outputs.cache-hit != 'true'
|
||||||
with:
|
with:
|
||||||
path: |
|
path: |
|
||||||
~/.npm
|
~/.npm
|
||||||
@@ -58,12 +72,16 @@ jobs:
|
|||||||
key: swcli-${{ runner.os }}-${{ hashFiles('composer.json', 'src/Resources/app/**/package*.json') }}
|
key: swcli-${{ runner.os }}-${{ hashFiles('composer.json', 'src/Resources/app/**/package*.json') }}
|
||||||
restore-keys: swcli-${{ runner.os }}-
|
restore-keys: swcli-${{ runner.os }}-
|
||||||
|
|
||||||
- name: Package extension (prebuilt admin/storefront assets)
|
- name: Package extension (only if the tested zip is not available)
|
||||||
if: steps.meta.outputs.skip == 'false'
|
if: steps.meta.outputs.skip == 'false' && steps.prebuilt.outputs.cache-hit != 'true'
|
||||||
run: |
|
run: |
|
||||||
shopware-cli extension package . --output-directory .build \
|
shopware-cli extension package . --output-directory .build --filename package.zip --git-commit "$GITHUB_SHA"
|
||||||
--filename "${{ steps.meta.outputs.zip }}" --git-commit "$GITHUB_SHA"
|
|
||||||
|
|
||||||
|
- name: Name the zip
|
||||||
|
if: steps.meta.outputs.skip == 'false'
|
||||||
|
run: mv .build/package.zip ".build/${{ steps.meta.outputs.zip }}"
|
||||||
|
|
||||||
|
# Cheap, and guards against a bad cache entry: always validate what ships.
|
||||||
- name: Validate packaged zip
|
- name: Validate packaged zip
|
||||||
if: steps.meta.outputs.skip == 'false'
|
if: steps.meta.outputs.skip == 'false'
|
||||||
run: shopware-cli extension validate ".build/${{ steps.meta.outputs.zip }}"
|
run: shopware-cli extension validate ".build/${{ steps.meta.outputs.zip }}"
|
||||||
|
|||||||
Reference in new issue
Block a user