Compare commits
18
Commits
v0.0.4
...
85980ee3bf
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
85980ee3bf | ||
|
|
8a72751a14 | ||
|
|
233f3eb17f | ||
|
|
37aba5d2f0 | ||
|
|
9f760cb6b0 | ||
|
|
ff69377749 | ||
|
|
c3b242675e | ||
|
|
1ec194b464 | ||
|
|
221ffece3f | ||
|
|
54eeab70aa | ||
|
|
89a445f900 | ||
|
|
a551034442 | ||
|
|
8efaef2042 | ||
|
|
29974928d2 | ||
|
|
36ef203797 | ||
|
|
ba2d1ec1d6 | ||
|
|
d117444bae | ||
|
|
58df03216d |
No files matched your search
@@ -0,0 +1,22 @@
|
|||||||
|
compatibility_date: 2026-02-11
|
||||||
|
# shopware-cli extension configuration (build/package/validate)
|
||||||
|
build:
|
||||||
|
zip:
|
||||||
|
pack:
|
||||||
|
excludes:
|
||||||
|
paths:
|
||||||
|
- tests
|
||||||
|
- docs
|
||||||
|
- scripts
|
||||||
|
- phpunit.xml
|
||||||
|
- docker-compose.yml
|
||||||
|
- skills-lock.json
|
||||||
|
- AGENTS.md
|
||||||
|
- CLAUDE.md
|
||||||
|
- QWEN.md
|
||||||
|
- .claude
|
||||||
|
- .scratch
|
||||||
|
- .wayfinder
|
||||||
|
- src/Resources/config/plugin-transparent.png
|
||||||
|
validation:
|
||||||
|
ignore: []
|
||||||
@@ -0,0 +1,35 @@
|
|||||||
|
name: package-extension
|
||||||
|
description: >-
|
||||||
|
Package the Shopware extension with shopware-cli (builds admin/storefront assets), validate the
|
||||||
|
zip and assert it contains the built JS. Shared by the PR checks and the release workflow.
|
||||||
|
Must run in the ghcr.io/shopware/shopware-cli image, after actions/checkout.
|
||||||
|
|
||||||
|
inputs:
|
||||||
|
filename:
|
||||||
|
description: Name of the zip written to .build/
|
||||||
|
default: package.zip
|
||||||
|
build:
|
||||||
|
description: "'false' skips packaging (a prebuilt zip is already in .build/) and only validates it"
|
||||||
|
default: 'true'
|
||||||
|
|
||||||
|
runs:
|
||||||
|
using: composite
|
||||||
|
steps:
|
||||||
|
- uses: actions/cache@v4
|
||||||
|
if: inputs.build == 'true'
|
||||||
|
with:
|
||||||
|
path: |
|
||||||
|
~/.npm
|
||||||
|
~/.cache/shopware-cli
|
||||||
|
key: swcli-${{ runner.os }}-${{ hashFiles('composer.json', 'src/Resources/app/**/package*.json') }}
|
||||||
|
restore-keys: swcli-${{ runner.os }}-
|
||||||
|
- name: Package extension
|
||||||
|
if: inputs.build == 'true'
|
||||||
|
shell: bash
|
||||||
|
run: shopware-cli extension package . --output-directory .build --filename "${{ inputs.filename }}" --git-commit "$GITHUB_SHA"
|
||||||
|
- name: Validate packaged zip
|
||||||
|
shell: bash
|
||||||
|
run: shopware-cli extension validate ".build/${{ inputs.filename }}"
|
||||||
|
- name: Assert built JS is in the zip
|
||||||
|
shell: bash
|
||||||
|
run: scripts/ci/assert-built-assets.sh ".build/${{ inputs.filename }}"
|
||||||
@@ -0,0 +1,148 @@
|
|||||||
|
name: plugin-checks
|
||||||
|
|
||||||
|
# Plugin-agnostic: nothing below names this plugin. Name, version and paths come from composer.json.
|
||||||
|
# shopware-cli runs from its official Docker image, intentionally unpinned (latest); a red build
|
||||||
|
# after a CLI release means fix the config.
|
||||||
|
|
||||||
|
on:
|
||||||
|
pull_request:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
permissions:
|
||||||
|
contents: read
|
||||||
|
|
||||||
|
# A new push to the PR cancels the superseded run.
|
||||||
|
concurrency:
|
||||||
|
group: plugin-checks-${{ github.ref }}
|
||||||
|
cancel-in-progress: true
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
# Every PR into main must bump the version and document it in CHANGELOG.md.
|
||||||
|
version-changelog:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
|
||||||
|
- name: Check version bump and changelog entry
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
PR_VERSION=$(grep -m1 '"version"' composer.json | sed -E 's/.*"version"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
|
||||||
|
MAIN_VERSION=$(git show origin/main:composer.json | grep -m1 '"version"' | sed -E 's/.*"version"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
|
||||||
|
|
||||||
|
echo "main version: $MAIN_VERSION"
|
||||||
|
echo "PR version: $PR_VERSION"
|
||||||
|
|
||||||
|
if [ "$MAIN_VERSION" = "$PR_VERSION" ]; then
|
||||||
|
echo "::error::composer.json version ($PR_VERSION) was not bumped from main ($MAIN_VERSION)"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
HIGHEST=$(printf '%s\n%s\n' "$MAIN_VERSION" "$PR_VERSION" | sort -V | tail -n1)
|
||||||
|
if [ "$HIGHEST" != "$PR_VERSION" ]; then
|
||||||
|
echo "::error::composer.json version ($PR_VERSION) is not greater than main's ($MAIN_VERSION)"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
if ! grep -qF "## [$PR_VERSION]" CHANGELOG.md; then
|
||||||
|
echo "::error::CHANGELOG.md is missing a '## [$PR_VERSION]' heading"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
echo "OK: version bumped to $PR_VERSION and documented in CHANGELOG.md"
|
||||||
|
|
||||||
|
# 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.
|
||||||
|
package:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ghcr.io/shopware/shopware-cli:latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
fetch-depth: 0
|
||||||
|
- uses: ./.gitea/actions/package
|
||||||
|
# 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:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
# Same image as above: it already ships PHP, Composer and Node, so no apt install.
|
||||||
|
container:
|
||||||
|
image: ghcr.io/shopware/shopware-cli:latest
|
||||||
|
services:
|
||||||
|
database:
|
||||||
|
# Shopware 6.6 supports MariaDB 10.11 / MySQL 8; 11.4 broke Shopware's own migrations.
|
||||||
|
image: mariadb:10.11
|
||||||
|
env:
|
||||||
|
MARIADB_ROOT_PASSWORD: root
|
||||||
|
env:
|
||||||
|
# Already the *_test name: Shopware's TestBootstrapper would otherwise append _test and run every migration a second time.
|
||||||
|
DATABASE_URL: mysql://root:root@database:3306/shopware_test
|
||||||
|
APP_ENV: test
|
||||||
|
APP_URL: http://localhost
|
||||||
|
APP_SECRET: ci-secret-not-for-production
|
||||||
|
INSTANCE_ID: ci
|
||||||
|
COMPOSER_MEMORY_LIMIT: '-1'
|
||||||
|
COMPOSER_ALLOW_SUPERUSER: '1'
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
with:
|
||||||
|
path: plugin-src
|
||||||
|
- 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:
|
||||||
|
path: shopware
|
||||||
|
key: shopware-6.6-prepared-${{ steps.stamp.outputs.month }}
|
||||||
|
- name: Create Shopware 6.6 project
|
||||||
|
if: steps.project.outputs.cache-hit != 'true'
|
||||||
|
run: |
|
||||||
|
set -e
|
||||||
|
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
|
||||||
|
run: |
|
||||||
|
for i in $(seq 60); do
|
||||||
|
(echo > /dev/tcp/database/3306) 2>/dev/null && exit 0
|
||||||
|
sleep 2
|
||||||
|
done
|
||||||
|
echo "::error::database service did not come up"; exit 1
|
||||||
|
- 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: |
|
||||||
|
# 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"];')
|
||||||
|
PLUGIN_NAME="${CLASS##*\\}"
|
||||||
|
echo "PLUGIN_NAME=${PLUGIN_NAME}" >> "$GITHUB_ENV"
|
||||||
|
rm -rf "shopware/custom/plugins/${PLUGIN_NAME}"
|
||||||
|
cp -r plugin-src "shopware/custom/plugins/${PLUGIN_NAME}"
|
||||||
|
# One install into shopware_test; the bootstrapper sees an installed DB, skips its own install and
|
||||||
|
# only activates the plugin (tests/TestBootstrap.php forces plugin installation).
|
||||||
|
- name: Install Shopware (once)
|
||||||
|
working-directory: shopware
|
||||||
|
run: bin/console system:install --basic-setup --create-database --force --no-interaction
|
||||||
|
- name: Run phpunit
|
||||||
|
working-directory: shopware
|
||||||
|
run: vendor/bin/phpunit -c "custom/plugins/${PLUGIN_NAME}/phpunit.xml"
|
||||||
@@ -1,40 +0,0 @@
|
|||||||
name: version-changelog
|
|
||||||
|
|
||||||
on:
|
|
||||||
pull_request:
|
|
||||||
branches: [main]
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
version-changelog:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v4
|
|
||||||
with:
|
|
||||||
fetch-depth: 0
|
|
||||||
|
|
||||||
- name: Check version bump and changelog entry
|
|
||||||
run: |
|
|
||||||
set -e
|
|
||||||
PR_VERSION=$(grep -m1 '"version"' composer.json | sed -E 's/.*"version"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
|
|
||||||
MAIN_VERSION=$(git show origin/main:composer.json | grep -m1 '"version"' | sed -E 's/.*"version"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
|
|
||||||
|
|
||||||
echo "main version: $MAIN_VERSION"
|
|
||||||
echo "PR version: $PR_VERSION"
|
|
||||||
|
|
||||||
if [ "$MAIN_VERSION" = "$PR_VERSION" ]; then
|
|
||||||
echo "::error::composer.json version ($PR_VERSION) was not bumped from main ($MAIN_VERSION)"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
HIGHEST=$(printf '%s\n%s\n' "$MAIN_VERSION" "$PR_VERSION" | sort -V | tail -n1)
|
|
||||||
if [ "$HIGHEST" != "$PR_VERSION" ]; then
|
|
||||||
echo "::error::composer.json version ($PR_VERSION) is not greater than main's ($MAIN_VERSION)"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
if ! grep -qF "## [$PR_VERSION]" CHANGELOG.md; then
|
|
||||||
echo "::error::CHANGELOG.md is missing a '## [$PR_VERSION]' heading"
|
|
||||||
exit 1
|
|
||||||
fi
|
|
||||||
|
|
||||||
echo "OK: version bumped to $PR_VERSION and documented in CHANGELOG.md"
|
|
||||||
@@ -1,31 +1,52 @@
|
|||||||
name: release
|
name: release
|
||||||
|
|
||||||
|
# Plugin-agnostic: owner, repo, host, package name and version come from the `github` context
|
||||||
|
# and composer.json. shopware-cli runs from its official Docker image, intentionally unpinned (latest).
|
||||||
|
# RELEASE_TOKEN is the single token used for releases, assets and the Composer registry.
|
||||||
|
|
||||||
on:
|
on:
|
||||||
push:
|
push:
|
||||||
branches: [main]
|
branches: [main]
|
||||||
|
|
||||||
env:
|
permissions:
|
||||||
SERVER_URL: https://git.arthurerlich.de
|
contents: write
|
||||||
|
packages: write
|
||||||
|
|
||||||
|
# Never run two releases at once; a second push waits instead of racing on the tag.
|
||||||
|
concurrency:
|
||||||
|
group: release
|
||||||
|
cancel-in-progress: false
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
release:
|
release:
|
||||||
runs-on: ubuntu-latest
|
runs-on: ubuntu-latest
|
||||||
|
container:
|
||||||
|
image: ghcr.io/shopware/shopware-cli:latest
|
||||||
steps:
|
steps:
|
||||||
|
- name: Ensure helper tools (jq, curl, unzip, git)
|
||||||
|
run: |
|
||||||
|
command -v jq >/dev/null && command -v curl >/dev/null && command -v unzip >/dev/null && command -v git >/dev/null && exit 0
|
||||||
|
(apt-get update -q && apt-get install -y -q --no-install-recommends jq curl unzip git) || apk add --no-cache jq curl unzip git
|
||||||
|
|
||||||
- uses: actions/checkout@v4
|
- uses: actions/checkout@v4
|
||||||
with:
|
with:
|
||||||
fetch-depth: 0
|
fetch-depth: 0
|
||||||
token: ${{ secrets.RELEASE_TOKEN }}
|
token: ${{ secrets.RELEASE_TOKEN }}
|
||||||
|
|
||||||
- name: Determine version and guard against re-release
|
- name: Determine version and guard against re-release
|
||||||
id: version
|
id: meta
|
||||||
run: |
|
run: |
|
||||||
set -e
|
set -e
|
||||||
VERSION=$(grep -m1 '"version"' composer.json | sed -E 's/.*"version"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
|
VERSION=$(jq -r .version composer.json)
|
||||||
PACKAGE_NAME=$(grep -m1 '"name"' composer.json | sed -E 's/.*"name"[[:space:]]*:[[:space:]]*"([^"]+)".*/\1/')
|
PACKAGE_NAME=$(jq -r .name composer.json)
|
||||||
|
REPO_NAME="${GITHUB_REPOSITORY#*/}"
|
||||||
TAG="v${VERSION}"
|
TAG="v${VERSION}"
|
||||||
echo "version=${VERSION}" >> "$GITHUB_OUTPUT"
|
{
|
||||||
echo "package_name=${PACKAGE_NAME}" >> "$GITHUB_OUTPUT"
|
echo "version=${VERSION}"
|
||||||
echo "tag=${TAG}" >> "$GITHUB_OUTPUT"
|
echo "package_name=${PACKAGE_NAME}"
|
||||||
|
echo "tag=${TAG}"
|
||||||
|
echo "zip=${REPO_NAME}-${TAG}.zip"
|
||||||
|
} >> "$GITHUB_OUTPUT"
|
||||||
if git ls-remote --tags origin "refs/tags/${TAG}" | grep -q "${TAG}"; then
|
if git ls-remote --tags origin "refs/tags/${TAG}" | grep -q "${TAG}"; then
|
||||||
echo "skip=true" >> "$GITHUB_OUTPUT"
|
echo "skip=true" >> "$GITHUB_OUTPUT"
|
||||||
echo "Tag ${TAG} already exists, nothing to release."
|
echo "Tag ${TAG} already exists, nothing to release."
|
||||||
@@ -33,68 +54,66 @@ jobs:
|
|||||||
echo "skip=false" >> "$GITHUB_OUTPUT"
|
echo "skip=false" >> "$GITHUB_OUTPUT"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
|
# 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'
|
||||||
|
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 }}
|
||||||
|
|
||||||
|
- name: Name the prebuilt zip
|
||||||
|
if: steps.meta.outputs.skip == 'false' && steps.prebuilt.outputs.cache-hit == 'true'
|
||||||
|
run: mv .build/package.zip ".build/${{ steps.meta.outputs.zip }}"
|
||||||
|
|
||||||
|
# Packages only on a cache miss; always validates and asserts what ships (guards a bad cache entry).
|
||||||
|
- uses: ./.gitea/actions/package
|
||||||
|
if: steps.meta.outputs.skip == 'false'
|
||||||
|
with:
|
||||||
|
filename: ${{ steps.meta.outputs.zip }}
|
||||||
|
build: ${{ steps.prebuilt.outputs.cache-hit != 'true' }}
|
||||||
|
|
||||||
- name: Extract changelog section
|
- name: Extract changelog section
|
||||||
if: steps.version.outputs.skip == 'false'
|
if: steps.meta.outputs.skip == 'false'
|
||||||
run: |
|
run: |
|
||||||
awk -v ver="${{ steps.version.outputs.version }}" '
|
awk -v ver="${{ steps.meta.outputs.version }}" '
|
||||||
BEGIN { found=0 }
|
BEGIN { found=0 }
|
||||||
/^## \[/ {
|
/^## \[/ {
|
||||||
if (found) exit
|
if (found) exit
|
||||||
if ($0 ~ "\[" ver "\]") { found=1; next }
|
if ($0 ~ "\\[" ver "\\]") { found=1; next }
|
||||||
}
|
}
|
||||||
found { print }
|
found { print }
|
||||||
' CHANGELOG.md > release-notes.md
|
' CHANGELOG.md > release-notes.md
|
||||||
cat release-notes.md
|
cat release-notes.md
|
||||||
|
|
||||||
- name: Create and push tag
|
- name: Create Gitea release (creates the tag) and upload the zip
|
||||||
if: steps.version.outputs.skip == 'false'
|
if: steps.meta.outputs.skip == 'false'
|
||||||
|
env:
|
||||||
|
TOKEN: ${{ secrets.RELEASE_TOKEN }}
|
||||||
run: |
|
run: |
|
||||||
git config user.name "gitea-actions"
|
set -e
|
||||||
git config user.email "actions@git.arthurerlich.de"
|
API="${GITHUB_SERVER_URL}/api/v1/repos/${GITHUB_REPOSITORY}"
|
||||||
git tag "${{ steps.version.outputs.tag }}"
|
BODY=$(jq -n --arg tag "${{ steps.meta.outputs.tag }}" --arg sha "$GITHUB_SHA" --rawfile notes release-notes.md \
|
||||||
git push origin "${{ steps.version.outputs.tag }}"
|
'{tag_name:$tag, target_commitish:$sha, name:$tag, body:$notes}')
|
||||||
|
RELEASE_ID=$(curl -sf -H "Authorization: token ${TOKEN}" -H "Content-Type: application/json" -d "$BODY" "${API}/releases" | jq -r .id)
|
||||||
|
echo "release id: ${RELEASE_ID}"
|
||||||
|
curl -sf -H "Authorization: token ${TOKEN}" \
|
||||||
|
-F "attachment=@.build/${{ steps.meta.outputs.zip }}" \
|
||||||
|
"${API}/releases/${RELEASE_ID}/assets?name=${{ steps.meta.outputs.zip }}" > /dev/null
|
||||||
|
|
||||||
- name: Install shopware-cli
|
- name: Publish the same zip to the Composer registry
|
||||||
if: steps.version.outputs.skip == 'false'
|
if: steps.meta.outputs.skip == 'false'
|
||||||
run: |
|
|
||||||
curl -sL -o /tmp/shopware-cli.tar.gz \
|
|
||||||
https://github.com/shopware/shopware-cli/releases/latest/download/shopware-cli_Linux_x86_64.tar.gz
|
|
||||||
mkdir -p /tmp/swcli-extract
|
|
||||||
tar -xzf /tmp/shopware-cli.tar.gz -C /tmp/swcli-extract
|
|
||||||
cp /tmp/swcli-extract/shopware-cli /usr/local/bin/shopware-cli
|
|
||||||
|
|
||||||
- name: Validate extension (informational only, does not gate the release)
|
|
||||||
if: steps.version.outputs.skip == 'false'
|
|
||||||
run: shopware-cli extension validate . || true
|
|
||||||
|
|
||||||
- name: Package Store-style zip for the Gitea Release asset
|
|
||||||
if: steps.version.outputs.skip == 'false'
|
|
||||||
run: |
|
|
||||||
shopware-cli extension package . --output-directory .build \
|
|
||||||
--filename "AeonDumpManager-${{ steps.version.outputs.tag }}.zip"
|
|
||||||
|
|
||||||
- name: Build root-level zip for the Composer registry
|
|
||||||
if: steps.version.outputs.skip == 'false'
|
|
||||||
run: git archive --format=zip -o "composer-package-${{ steps.version.outputs.tag }}.zip" "${{ steps.version.outputs.tag }}"
|
|
||||||
|
|
||||||
- name: Create Gitea Release
|
|
||||||
if: steps.version.outputs.skip == 'false'
|
|
||||||
uses: akkuman/gitea-release-action@v1
|
|
||||||
with:
|
|
||||||
server_url: ${{ env.SERVER_URL }}
|
|
||||||
token: ${{ secrets.RELEASE_TOKEN }}
|
|
||||||
tag_name: ${{ steps.version.outputs.tag }}
|
|
||||||
name: ${{ steps.version.outputs.tag }}
|
|
||||||
body_path: release-notes.md
|
|
||||||
files: .build/AeonDumpManager-${{ steps.version.outputs.tag }}.zip
|
|
||||||
|
|
||||||
- name: Publish to Composer registry
|
|
||||||
if: steps.version.outputs.skip == 'false'
|
|
||||||
run: |
|
run: |
|
||||||
STATUS=$(curl -s -o /tmp/composer-publish.log -w "%{http_code}" \
|
STATUS=$(curl -s -o /tmp/composer-publish.log -w "%{http_code}" \
|
||||||
-u "haylan:${{ secrets.RELEASE_TOKEN }}" \
|
-u "${GITHUB_REPOSITORY_OWNER}:${{ secrets.RELEASE_TOKEN }}" \
|
||||||
-T "composer-package-${{ steps.version.outputs.tag }}.zip" \
|
-T ".build/${{ steps.meta.outputs.zip }}" \
|
||||||
"https://git.arthurerlich.de/api/packages/haylan/composer")
|
"${GITHUB_SERVER_URL}/api/packages/${GITHUB_REPOSITORY_OWNER}/composer")
|
||||||
cat /tmp/composer-publish.log
|
cat /tmp/composer-publish.log
|
||||||
if [ "$STATUS" != "201" ] && [ "$STATUS" != "409" ]; then
|
if [ "$STATUS" != "201" ] && [ "$STATUS" != "409" ]; then
|
||||||
echo "Unexpected HTTP status $STATUS publishing to the Composer registry"
|
echo "Unexpected HTTP status $STATUS publishing to the Composer registry"
|
||||||
@@ -102,10 +121,11 @@ jobs:
|
|||||||
fi
|
fi
|
||||||
|
|
||||||
- name: Link Composer package to this repository
|
- name: Link Composer package to this repository
|
||||||
if: steps.version.outputs.skip == 'false'
|
if: steps.meta.outputs.skip == 'false'
|
||||||
run: |
|
run: |
|
||||||
ENCODED_NAME=$(printf '%s' "${{ steps.version.outputs.package_name }}" | sed 's#/#%2F#g')
|
ENCODED_NAME=$(printf '%s' "${{ steps.meta.outputs.package_name }}" | sed 's#/#%2F#g')
|
||||||
STATUS=$(curl -s -o /dev/null -w "%{http_code}" -u "haylan:${{ secrets.RELEASE_TOKEN }}" -X POST "https://git.arthurerlich.de/api/v1/packages/haylan/composer/${ENCODED_NAME}/-/link/AeonDumpManager")
|
STATUS=$(curl -s -o /dev/null -w "%{http_code}" -u "${GITHUB_REPOSITORY_OWNER}:${{ secrets.RELEASE_TOKEN }}" -X POST \
|
||||||
|
"${GITHUB_SERVER_URL}/api/v1/packages/${GITHUB_REPOSITORY_OWNER}/composer/${ENCODED_NAME}/-/link/${GITHUB_REPOSITORY#*/}")
|
||||||
echo "link status: $STATUS"
|
echo "link status: $STATUS"
|
||||||
if [ "$STATUS" != "201" ] && [ "$STATUS" != "400" ]; then
|
if [ "$STATUS" != "201" ] && [ "$STATUS" != "400" ]; then
|
||||||
echo "::warning::Unexpected status linking the Composer package to this repository (HTTP $STATUS) - not fatal, release already published"
|
echo "::warning::Unexpected status linking the Composer package to this repository (HTTP $STATUS) - not fatal, release already published"
|
||||||
|
|||||||
@@ -7,6 +7,29 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
|
## [0.1.0] - 2026-10-03
|
||||||
|
|
||||||
|
### Changed
|
||||||
|
|
||||||
|
- Services and routes are now configured in YAML; the plugin requires PHP `^8.2`.
|
||||||
|
- Release pipeline: the packaged `shopware-cli` zip (with prebuilt assets) is validated and used for both the Gitea Release and the Composer registry; the release is created through the Gitea API after packaging, so a failed build no longer leaves an orphan tag.
|
||||||
|
- New PR checks: `shopware-cli` validate, package build and phpunit.
|
||||||
|
|
||||||
|
### Added
|
||||||
|
|
||||||
|
- Dedicated `aeon_dump_manager` monolog channel; dump jobs, deletions and purges are logged.
|
||||||
|
- Extension icon and `.config/shopware-extension.yml`.
|
||||||
|
|
||||||
|
### Removed
|
||||||
|
|
||||||
|
- Empty plugin lifecycle overrides.
|
||||||
|
|
||||||
|
## [0.0.5] - 2026-09-21
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
|
||||||
|
- Changed namespace
|
||||||
|
|
||||||
## [0.0.4] - 2026-09-21
|
## [0.0.4] - 2026-09-21
|
||||||
|
|
||||||
### Fixed
|
### Fixed
|
||||||
|
|||||||
@@ -14,7 +14,7 @@ the full build spec live under `.scratch/admin-dump-manager/` and `.scratch/dump
|
|||||||
- Plugin bootstrap class: `src/AeonDumpManager.php` (extends `Shopware\Core\Framework\Plugin`) — this
|
- Plugin bootstrap class: `src/AeonDumpManager.php` (extends `Shopware\Core\Framework\Plugin`) — this
|
||||||
is the entry point Shopware calls for install/uninstall/activate/deactivate/update lifecycle hooks.
|
is the entry point Shopware calls for install/uninstall/activate/deactivate/update lifecycle hooks.
|
||||||
- Plugin class name is wired via `composer.json` → `extra.shopware-plugin-class`.
|
- Plugin class name is wired via `composer.json` → `extra.shopware-plugin-class`.
|
||||||
- Services are registered manually in `src/Resources/config/services.xml` (Symfony DI, XML format,
|
- Services are registered manually in `src/Resources/config/services.yaml` (Symfony DI, YAML format,
|
||||||
autowiring is not configured — every new service/command/task must be added here explicitly with
|
autowiring is not configured — every new service/command/task must be added here explicitly with
|
||||||
its tag, e.g. `console.command` or `shopware.scheduled.task`).
|
its tag, e.g. `console.command` or `shopware.scheduled.task`).
|
||||||
- Plugin store-config UI fields (e.g. `maxDumps`, `retantionDays`) are defined in
|
- Plugin store-config UI fields (e.g. `maxDumps`, `retantionDays`) are defined in
|
||||||
@@ -66,7 +66,7 @@ vendor/bin/phpunit tests/SomeTest.php # single file
|
|||||||
## Adding functionality
|
## Adding functionality
|
||||||
|
|
||||||
- New console commands go in `src/Command/`, new scheduled tasks in `src/ScheduledTask/` — both must
|
- New console commands go in `src/Command/`, new scheduled tasks in `src/ScheduledTask/` — both must
|
||||||
be registered in `src/Resources/config/services.xml` with the appropriate tag or Shopware will not
|
be registered in `src/Resources/config/services.yaml` with the appropriate tag or Shopware will not
|
||||||
discover them.
|
discover them.
|
||||||
- Scheduled tasks need a matching handler (tagged `messenger.message_handler`) to actually run; a bare
|
- Scheduled tasks need a matching handler (tagged `messenger.message_handler`) to actually run; a bare
|
||||||
`ScheduledTask` subclass like `ExampleTask` only defines the schedule, not the behavior.
|
`ScheduledTask` subclass like `ExampleTask` only defines the schedule, not the behavior.
|
||||||
+7
-7
@@ -1,9 +1,9 @@
|
|||||||
{
|
{
|
||||||
"name": "aeon/dump-manager",
|
"name": "arthurerlich/aeon-dump-manager",
|
||||||
"description": "Export database dumps for Shopware 6 environments.",
|
"description": "Export database dumps for Shopware 6 environments.",
|
||||||
"type": "shopware-platform-plugin",
|
"type": "shopware-platform-plugin",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"version": "0.0.4",
|
"version": "0.1.0",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"shopware",
|
"shopware",
|
||||||
"shopware6",
|
"shopware6",
|
||||||
@@ -25,7 +25,7 @@
|
|||||||
"source": "https://git.arthurerlich.de/haylan/AeonDumpManager"
|
"source": "https://git.arthurerlich.de/haylan/AeonDumpManager"
|
||||||
},
|
},
|
||||||
"require": {
|
"require": {
|
||||||
"php": "^8.1",
|
"php": "^8.2",
|
||||||
"shopware/core": "~6.6.0"
|
"shopware/core": "~6.6.0"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
@@ -35,12 +35,12 @@
|
|||||||
"shopware-plugin-class": "AeonDumpManager\\AeonDumpManager",
|
"shopware-plugin-class": "AeonDumpManager\\AeonDumpManager",
|
||||||
"copyright": "(c) by Arthur Erlich",
|
"copyright": "(c) by Arthur Erlich",
|
||||||
"label": {
|
"label": {
|
||||||
"de-DE": "Aeon Dump Manager",
|
"de-DE": "Dump Manager",
|
||||||
"en-GB": "Aeon Dump Manager"
|
"en-GB": "Dump Manager"
|
||||||
},
|
},
|
||||||
"description": {
|
"description": {
|
||||||
"de-DE": "Verwaltet Datenbank-Dumps für Shopware 6 Entwicklungsumgebungen.",
|
"de-DE": "Für Datenbank-Backups in Shopware 6 Umgebungen erzeugt Dump Manager komprimierte SQL-Dumps per Backend oder Konsole, listet und löscht sie und räumt alte Dumps automatisch auf.",
|
||||||
"en-GB": "Manages database dumps for Shopware 6 development environments."
|
"en-GB": "To get a database dump for Shopware 6 environments, Dump Manager creates compressed SQL dumps from the admin or console, lists and deletes them, and purges old dumps automatically."
|
||||||
},
|
},
|
||||||
"manufacturerLink": {
|
"manufacturerLink": {
|
||||||
"de-DE": "https://arthurerlich.de",
|
"de-DE": "https://arthurerlich.de",
|
||||||
|
|||||||
@@ -0,0 +1,68 @@
|
|||||||
|
# Spec: Shopware plugin guideline compliance (build/release pipeline)
|
||||||
|
|
||||||
|
Outcome of the Wayfinder map `.scratch/shopware-guideline-compliance/` (tickets 01-05; research evidence
|
||||||
|
on branches `research/shopware-guideline-checklist`, `research/shopware-cli-ci-behaviour`,
|
||||||
|
`research/gitea-28-pipeline-standards`). Target: **Store-ready** artifacts, published to Gitea only
|
||||||
|
(Gitea Release + Composer registry). Uploading to the Shopware Store is out of scope.
|
||||||
|
|
||||||
|
## 1. Principles
|
||||||
|
|
||||||
|
- Workflows are **plugin-agnostic**: no plugin name, package name, owner, repo or host is hard-coded;
|
||||||
|
all derive from `composer.json` and the `gitea` context. The same files must work unchanged for a
|
||||||
|
second plugin and be extractable to Gitea's shared-workflow repository later.
|
||||||
|
- One artifact: the `shopware-cli extension package` zip (prebuilt admin/storefront JS) is used for
|
||||||
|
both the Gitea Release asset and the Composer registry.
|
||||||
|
- `shopware-cli` is intentionally **unpinned** (`latest`). Known tradeoff: a CLI release can turn PRs
|
||||||
|
red without a repo change; treat that as a signal to fix config.
|
||||||
|
- `RELEASE_TOKEN` is the only token (release, assets, registry publish, link). Workflows still declare
|
||||||
|
`permissions:`.
|
||||||
|
|
||||||
|
## 2. Plugin changes
|
||||||
|
|
||||||
|
| # | Change |
|
||||||
|
|---|--------|
|
||||||
|
| P1 | Commit `src/Resources/config/plugin.png` (256x256). Do not ship `plugin-transparent.png`. |
|
||||||
|
| P2 | Logging: monolog channel `aeon_dump_manager` (`Resources/config/packages/monolog.yaml`, `build()` in the plugin class loading `packages/*.yaml`); inject `monolog.logger.aeon_dump_manager` into `PurgeDumpsTaskHandler`, `DumpService`, `CreateDumpHandler`; log dump job start/finish/failure. |
|
||||||
|
| P3 | Migrate `services.xml` -> `services.yaml` and `routes.php` -> `routes.yaml`. No validation ignore for this. Update the "XML services" rule in `CLAUDE.md`. |
|
||||||
|
| P4 | `composer.json`: `php` -> `^8.2`. Verify Shopware 6.6's own PHP requirement. |
|
||||||
|
| P5 | Delete the empty lifecycle overrides in `AeonDumpManager`; keep `uninstall`. |
|
||||||
|
| P6 | `.config/shopware-extension.yml` for build excludes and validation settings (add ignores only for real, accepted findings). |
|
||||||
|
| P7 | Keep Keep-a-Changelog `CHANGELOG.md`; verify with a local `shopware-cli extension package --release` how the changelog is read. |
|
||||||
|
|
||||||
|
## 3. Pipeline
|
||||||
|
|
||||||
|
### PR workflows
|
||||||
|
|
||||||
|
Jobs (all required checks on `main`):
|
||||||
|
`pr-version-check.yml` (job `version-changelog`) is unchanged apart from `permissions:`; its name keeps the existing required context. New `plugin-checks.yml`:
|
||||||
|
|
||||||
|
1. `package` - `extension package` with `--git-commit "$GITHUB_SHA"`, `extension validate` on the resulting zip (hard gate; replaces a separate directory validate, which only repeats those checks), then `scripts/ci/assert-built-assets.sh` (built admin/storefront JS present when sources exist). All shopware-cli jobs run in `ghcr.io/shopware/shopware-cli:latest`; npm and shopware-cli caches via `actions/cache`.
|
||||||
|
2. `phpunit` - `composer create-project shopware/production` (6.6.x) + MariaDB service, copy the plugin into `custom/plugins`, install/activate, run phpunit. Runs in the same `shopware-cli` image (PHP and Composer included; `shivammathur/setup-php` hangs on this runner and apt installs cost ~4.5 min). MariaDB 10.11, because 11.4 broke Shopware's own migrations.
|
||||||
|
|
||||||
|
### Release workflow (`.gitea/workflows/release.yml`)
|
||||||
|
|
||||||
|
On push to `main`, guarded against re-release by an existing tag:
|
||||||
|
`extension package --git-commit "$GITHUB_SHA"` -> **validate the zip** -> assert built assets -> create the Gitea
|
||||||
|
release via API (`POST /repos/{owner}/{repo}/releases`, creates the tag) with the zip as asset ->
|
||||||
|
upload the same zip to the Composer registry -> link package to repository.
|
||||||
|
Removes the manual `git tag` step, the `akkuman` action and the `git archive` zip. Packaging happens
|
||||||
|
before the tag exists, so a failed build leaves no orphan tag.
|
||||||
|
|
||||||
|
### Branch protection (one-time, manual)
|
||||||
|
|
||||||
|
`scripts/protect-main.sh` using `tea api PATCH repos/{owner}/{repo}/branch_protections/main` to set the
|
||||||
|
required status-check contexts (current: `version-changelog / version-changelog (pull_request)`; add
|
||||||
|
the new PR jobs). `tea branches protect` cannot set status checks. Not run by the pipeline.
|
||||||
|
|
||||||
|
## 4. Open items to verify while implementing
|
||||||
|
|
||||||
|
- Release POST creates a missing tag (fallback: tag step after packaging).
|
||||||
|
- Meaning of HTTP 400 on the package-link endpoint.
|
||||||
|
- Whether bare `validate` runs PHPStan/ESLint (needs PHP/Node on the runner); Node availability on the runner image.
|
||||||
|
- Accepted size for `metadata.icon.size`; error-vs-warning rule list of validate.
|
||||||
|
- Whether `routes.php` is flagged by validate; `shopware-cli extension fix` correctness for the YAML migration.
|
||||||
|
- Exact status-check context names of the new jobs (set after the first run).
|
||||||
|
|
||||||
|
## 5. Out of scope / later
|
||||||
|
|
||||||
|
Shopware Store upload; Gitea shared-workflow repository; phpunit lowest-version matrix; Store listing metadata.
|
||||||
Executable
+17
@@ -0,0 +1,17 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# Assert that a packaged extension zip contains the built admin/storefront JS when the sources exist.
|
||||||
|
# Usage: scripts/ci/assert-built-assets.sh <zip> (run from the repo root; BusyBox-safe: uses unzip -l)
|
||||||
|
set -euo pipefail
|
||||||
|
ZIP="${1:?usage: assert-built-assets.sh <zip>}"
|
||||||
|
LIST=$(unzip -l "$ZIP")
|
||||||
|
|
||||||
|
check() { # <label> <entry-glob-prefix> <expected path in zip>
|
||||||
|
local label="$1" entry="$2" expected="$3"
|
||||||
|
if [ -f "${entry}/main.js" ] || [ -f "${entry}/main.ts" ]; then
|
||||||
|
echo "$LIST" | grep -q "$expected" || { echo "::error::${label} entry exists but the zip has no built ${label} JS (${expected})"; exit 1; }
|
||||||
|
echo "ok: ${label} JS is in the zip"
|
||||||
|
fi
|
||||||
|
}
|
||||||
|
|
||||||
|
check admin src/Resources/app/administration/src "Resources/public/administration/js/"
|
||||||
|
check storefront src/Resources/app/storefront/src "Resources/app/storefront/dist/"
|
||||||
Executable
+16
@@ -0,0 +1,16 @@
|
|||||||
|
#!/usr/bin/env bash
|
||||||
|
# One-time (re-runnable) setup: require the PR checks on `main` using the Gitea `tea` CLI.
|
||||||
|
# `tea branches protect` cannot set status-check contexts, hence `tea api`.
|
||||||
|
# Usage: scripts/protect-main.sh [owner/repo] (default: derived from the git remote)
|
||||||
|
set -euo pipefail
|
||||||
|
|
||||||
|
REPO="${1:-$(git config --get remote.origin.url | sed -E 's#^.*[:/]([^/]+/[^/]+)$#\1#; s#\.git$##')}"
|
||||||
|
|
||||||
|
tea api -X PATCH "repos/${REPO}/branch_protections/main" -d '{
|
||||||
|
"enable_status_check": true,
|
||||||
|
"status_check_contexts": [
|
||||||
|
"plugin-checks / version-changelog (pull_request)",
|
||||||
|
"plugin-checks / package (pull_request)",
|
||||||
|
"plugin-checks / phpunit (pull_request)"
|
||||||
|
]
|
||||||
|
}'
|
||||||
+22
-31
@@ -4,17 +4,33 @@ namespace AeonDumpManager;
|
|||||||
|
|
||||||
use Doctrine\DBAL\Connection;
|
use Doctrine\DBAL\Connection;
|
||||||
use Shopware\Core\Framework\Plugin;
|
use Shopware\Core\Framework\Plugin;
|
||||||
use Shopware\Core\Framework\Plugin\Context\ActivateContext;
|
|
||||||
use Shopware\Core\Framework\Plugin\Context\DeactivateContext;
|
|
||||||
use Shopware\Core\Framework\Plugin\Context\InstallContext;
|
|
||||||
use Shopware\Core\Framework\Plugin\Context\UninstallContext;
|
use Shopware\Core\Framework\Plugin\Context\UninstallContext;
|
||||||
use Shopware\Core\Framework\Plugin\Context\UpdateContext;
|
use Symfony\Component\Config\FileLocator;
|
||||||
|
use Symfony\Component\Config\Loader\DelegatingLoader;
|
||||||
|
use Symfony\Component\Config\Loader\LoaderResolver;
|
||||||
|
use Symfony\Component\DependencyInjection\ContainerBuilder;
|
||||||
|
use Symfony\Component\DependencyInjection\Loader\DirectoryLoader;
|
||||||
|
use Symfony\Component\DependencyInjection\Loader\GlobFileLoader;
|
||||||
|
use Symfony\Component\DependencyInjection\Loader\YamlFileLoader;
|
||||||
|
|
||||||
class AeonDumpManager extends Plugin
|
class AeonDumpManager extends Plugin
|
||||||
{
|
{
|
||||||
public function install(InstallContext $installContext): void
|
public function build(ContainerBuilder $container): void
|
||||||
{
|
{
|
||||||
// Do stuff such as creating a new payment method
|
parent::build($container);
|
||||||
|
|
||||||
|
// Registers the dedicated monolog channel (Resources/config/packages/monolog.yaml)
|
||||||
|
$locator = new FileLocator('Resources/config');
|
||||||
|
$resolver = new LoaderResolver([
|
||||||
|
new YamlFileLoader($container, $locator),
|
||||||
|
new GlobFileLoader($container, $locator),
|
||||||
|
new DirectoryLoader($container, $locator),
|
||||||
|
]);
|
||||||
|
|
||||||
|
(new DelegatingLoader($resolver))->load(
|
||||||
|
\rtrim($this->getPath(), '/') . '/Resources/config/packages/*.yaml',
|
||||||
|
'glob'
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
public function uninstall(UninstallContext $uninstallContext): void
|
public function uninstall(UninstallContext $uninstallContext): void
|
||||||
@@ -29,29 +45,4 @@ class AeonDumpManager extends Plugin
|
|||||||
$connection = $this->container->get(Connection::class);
|
$connection = $this->container->get(Connection::class);
|
||||||
$connection->executeStatement('DROP TABLE IF EXISTS `aeon_dump_manager_job`');
|
$connection->executeStatement('DROP TABLE IF EXISTS `aeon_dump_manager_job`');
|
||||||
}
|
}
|
||||||
|
|
||||||
public function activate(ActivateContext $activateContext): void
|
|
||||||
{
|
|
||||||
// Activate entities, such as a new payment method
|
|
||||||
// Or create new entities here, because now your plugin is installed and active for sure
|
|
||||||
}
|
|
||||||
|
|
||||||
public function deactivate(DeactivateContext $deactivateContext): void
|
|
||||||
{
|
|
||||||
// Deactivate entities, such as a new payment method
|
|
||||||
// Or remove previously created entities
|
|
||||||
}
|
|
||||||
|
|
||||||
public function update(UpdateContext $updateContext): void
|
|
||||||
{
|
|
||||||
// Update necessary stuff, mostly non-database related
|
|
||||||
}
|
|
||||||
|
|
||||||
public function postInstall(InstallContext $installContext): void
|
|
||||||
{
|
|
||||||
}
|
|
||||||
|
|
||||||
public function postUpdate(UpdateContext $updateContext): void
|
|
||||||
{
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
@@ -5,6 +5,7 @@ namespace AeonDumpManager\MessageQueue\Handler;
|
|||||||
use AeonDumpManager\MessageQueue\Message\CreateDumpMessage;
|
use AeonDumpManager\MessageQueue\Message\CreateDumpMessage;
|
||||||
use AeonDumpManager\Service\DumpJobStatusService;
|
use AeonDumpManager\Service\DumpJobStatusService;
|
||||||
use AeonDumpManager\Service\DumpService;
|
use AeonDumpManager\Service\DumpService;
|
||||||
|
use Psr\Log\LoggerInterface;
|
||||||
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
|
use Symfony\Component\Messenger\Attribute\AsMessageHandler;
|
||||||
|
|
||||||
#[AsMessageHandler]
|
#[AsMessageHandler]
|
||||||
@@ -13,6 +14,7 @@ class CreateDumpHandler
|
|||||||
public function __construct(
|
public function __construct(
|
||||||
private readonly DumpService $dumpService,
|
private readonly DumpService $dumpService,
|
||||||
private readonly DumpJobStatusService $jobStatus,
|
private readonly DumpJobStatusService $jobStatus,
|
||||||
|
private readonly LoggerInterface $logger,
|
||||||
) {
|
) {
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -20,10 +22,12 @@ class CreateDumpHandler
|
|||||||
{
|
{
|
||||||
$jobId = $message->getJobId();
|
$jobId = $message->getJobId();
|
||||||
$this->jobStatus->markRunning($jobId);
|
$this->jobStatus->markRunning($jobId);
|
||||||
|
$this->logger->info('Dump job started.', ['jobId' => $jobId]);
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$this->dumpService->createAsync($jobId, $this->jobStatus);
|
$this->dumpService->createAsync($jobId, $this->jobStatus);
|
||||||
} catch (\Throwable $exception) {
|
} catch (\Throwable $exception) {
|
||||||
|
$this->logger->error('Dump job failed.', ['jobId' => $jobId, 'exception' => $exception]);
|
||||||
$this->jobStatus->markFailed($jobId, $exception->getMessage());
|
$this->jobStatus->markFailed($jobId, $exception->getMessage());
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
monolog:
|
||||||
|
channels: ['aeon_dump_manager']
|
||||||
Binary file not shown.
|
After Width: | Height: | Size: 53 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 12 KiB |
@@ -1,7 +0,0 @@
|
|||||||
<?php declare(strict_types=1);
|
|
||||||
|
|
||||||
use Symfony\Component\Routing\Loader\Configurator\RoutingConfigurator;
|
|
||||||
|
|
||||||
return function (RoutingConfigurator $routes): void {
|
|
||||||
$routes->import(__DIR__ . '/../../Controller/*Controller.php', 'attribute');
|
|
||||||
};
|
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
aeon_dump_manager_controllers:
|
||||||
|
resource: ../../Controller/*Controller.php
|
||||||
|
type: attribute
|
||||||
@@ -1,88 +0,0 @@
|
|||||||
<?xml version="1.0" ?>
|
|
||||||
|
|
||||||
<container xmlns="http://symfony.com/schema/dic/services"
|
|
||||||
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
|
||||||
xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
|
|
||||||
|
|
||||||
<services>
|
|
||||||
<!-- Services -->
|
|
||||||
|
|
||||||
<service id="Symfony\Component\Process\ExecutableFinder"/>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.dump_filename_parser" class="AeonDumpManager\Service\DumpFilenameParser"/>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.dump_binary_locator" class="AeonDumpManager\Service\DumpBinaryLocator">
|
|
||||||
<argument type="service" id="Doctrine\DBAL\Connection"/>
|
|
||||||
<argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
|
|
||||||
<argument type="service" id="Symfony\Component\Process\ExecutableFinder"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.dump_job_status_service" class="AeonDumpManager\Service\DumpJobStatusService">
|
|
||||||
<argument type="service" id="Doctrine\DBAL\Connection"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.dump_lister" class="AeonDumpManager\Service\DumpLister">
|
|
||||||
<argument type="service" id="aeon_dump_manager.filesystem.private"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_filename_parser"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.dump_service" class="AeonDumpManager\Service\DumpService">
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_lister"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.filesystem.private"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_binary_locator"/>
|
|
||||||
<argument type="service" id="Doctrine\DBAL\Connection"/>
|
|
||||||
<argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_filename_parser"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<!-- Async create job -->
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.message_queue.create_dump_handler" class="AeonDumpManager\MessageQueue\Handler\CreateDumpHandler">
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_service"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_job_status_service"/>
|
|
||||||
<tag name="messenger.message_handler"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<!-- Retention -->
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.scheduled_task.purge_dumps_task" class="AeonDumpManager\ScheduledTask\PurgeDumpsTask">
|
|
||||||
<tag name="shopware.scheduled.task"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.scheduled_task.purge_dumps_task_handler" class="AeonDumpManager\ScheduledTask\PurgeDumpsTaskHandler">
|
|
||||||
<argument type="service" id="scheduled_task.repository"/>
|
|
||||||
<argument type="service" id="logger"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_service"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_job_status_service"/>
|
|
||||||
<argument type="service" id="Shopware\Core\System\SystemConfig\SystemConfigService"/>
|
|
||||||
<tag name="messenger.message_handler" handles="AeonDumpManager\ScheduledTask\PurgeDumpsTask"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<!-- Console commands -->
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.command.dump_list" class="AeonDumpManager\Command\DumpListCommand">
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_lister"/>
|
|
||||||
<tag name="console.command"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.command.dump_create" class="AeonDumpManager\Command\DumpCreateCommand">
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_service"/>
|
|
||||||
<tag name="console.command"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<service id="aeon_dump_manager.command.dump_remove" class="AeonDumpManager\Command\DumpRemoveCommand">
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_service"/>
|
|
||||||
<tag name="console.command"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
<!-- Admin API controller -->
|
|
||||||
|
|
||||||
<service id="AeonDumpManager\Controller\DumpController" public="true">
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_lister"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_service"/>
|
|
||||||
<argument type="service" id="aeon_dump_manager.dump_job_status_service"/>
|
|
||||||
<argument type="service" id="messenger.default_bus"/>
|
|
||||||
</service>
|
|
||||||
|
|
||||||
</services>
|
|
||||||
</container>
|
|
||||||
@@ -0,0 +1,92 @@
|
|||||||
|
services:
|
||||||
|
Symfony\Component\Process\ExecutableFinder: ~
|
||||||
|
|
||||||
|
aeon_dump_manager.dump_filename_parser:
|
||||||
|
class: AeonDumpManager\Service\DumpFilenameParser
|
||||||
|
|
||||||
|
aeon_dump_manager.dump_binary_locator:
|
||||||
|
class: AeonDumpManager\Service\DumpBinaryLocator
|
||||||
|
arguments:
|
||||||
|
- '@Doctrine\DBAL\Connection'
|
||||||
|
- '@Shopware\Core\System\SystemConfig\SystemConfigService'
|
||||||
|
- '@Symfony\Component\Process\ExecutableFinder'
|
||||||
|
|
||||||
|
aeon_dump_manager.dump_job_status_service:
|
||||||
|
class: AeonDumpManager\Service\DumpJobStatusService
|
||||||
|
arguments:
|
||||||
|
- '@Doctrine\DBAL\Connection'
|
||||||
|
|
||||||
|
aeon_dump_manager.dump_lister:
|
||||||
|
class: AeonDumpManager\Service\DumpLister
|
||||||
|
arguments:
|
||||||
|
- '@aeon_dump_manager.filesystem.private'
|
||||||
|
- '@aeon_dump_manager.dump_filename_parser'
|
||||||
|
|
||||||
|
aeon_dump_manager.dump_service:
|
||||||
|
class: AeonDumpManager\Service\DumpService
|
||||||
|
arguments:
|
||||||
|
- '@aeon_dump_manager.dump_lister'
|
||||||
|
- '@aeon_dump_manager.filesystem.private'
|
||||||
|
- '@aeon_dump_manager.dump_binary_locator'
|
||||||
|
- '@Doctrine\DBAL\Connection'
|
||||||
|
- '@Shopware\Core\System\SystemConfig\SystemConfigService'
|
||||||
|
- '@aeon_dump_manager.dump_filename_parser'
|
||||||
|
- '@monolog.logger.aeon_dump_manager'
|
||||||
|
|
||||||
|
# Async create job
|
||||||
|
aeon_dump_manager.message_queue.create_dump_handler:
|
||||||
|
class: AeonDumpManager\MessageQueue\Handler\CreateDumpHandler
|
||||||
|
arguments:
|
||||||
|
- '@aeon_dump_manager.dump_service'
|
||||||
|
- '@aeon_dump_manager.dump_job_status_service'
|
||||||
|
- '@monolog.logger.aeon_dump_manager'
|
||||||
|
tags:
|
||||||
|
- { name: messenger.message_handler }
|
||||||
|
|
||||||
|
# Retention
|
||||||
|
aeon_dump_manager.scheduled_task.purge_dumps_task:
|
||||||
|
class: AeonDumpManager\ScheduledTask\PurgeDumpsTask
|
||||||
|
tags:
|
||||||
|
- { name: shopware.scheduled.task }
|
||||||
|
|
||||||
|
aeon_dump_manager.scheduled_task.purge_dumps_task_handler:
|
||||||
|
class: AeonDumpManager\ScheduledTask\PurgeDumpsTaskHandler
|
||||||
|
arguments:
|
||||||
|
- '@scheduled_task.repository'
|
||||||
|
- '@monolog.logger.aeon_dump_manager'
|
||||||
|
- '@aeon_dump_manager.dump_service'
|
||||||
|
- '@aeon_dump_manager.dump_job_status_service'
|
||||||
|
- '@Shopware\Core\System\SystemConfig\SystemConfigService'
|
||||||
|
tags:
|
||||||
|
- { name: messenger.message_handler, handles: AeonDumpManager\ScheduledTask\PurgeDumpsTask }
|
||||||
|
|
||||||
|
# Console commands
|
||||||
|
aeon_dump_manager.command.dump_list:
|
||||||
|
class: AeonDumpManager\Command\DumpListCommand
|
||||||
|
arguments:
|
||||||
|
- '@aeon_dump_manager.dump_lister'
|
||||||
|
tags:
|
||||||
|
- { name: console.command }
|
||||||
|
|
||||||
|
aeon_dump_manager.command.dump_create:
|
||||||
|
class: AeonDumpManager\Command\DumpCreateCommand
|
||||||
|
arguments:
|
||||||
|
- '@aeon_dump_manager.dump_service'
|
||||||
|
tags:
|
||||||
|
- { name: console.command }
|
||||||
|
|
||||||
|
aeon_dump_manager.command.dump_remove:
|
||||||
|
class: AeonDumpManager\Command\DumpRemoveCommand
|
||||||
|
arguments:
|
||||||
|
- '@aeon_dump_manager.dump_service'
|
||||||
|
tags:
|
||||||
|
- { name: console.command }
|
||||||
|
|
||||||
|
# Admin API controller
|
||||||
|
AeonDumpManager\Controller\DumpController:
|
||||||
|
public: true
|
||||||
|
arguments:
|
||||||
|
- '@aeon_dump_manager.dump_lister'
|
||||||
|
- '@aeon_dump_manager.dump_service'
|
||||||
|
- '@aeon_dump_manager.dump_job_status_service'
|
||||||
|
- '@messenger.default_bus'
|
||||||
@@ -6,6 +6,7 @@ use AeonDumpManager\Service\Exception\DumpNotFoundException;
|
|||||||
use AeonDumpManager\Struct\DumpFile;
|
use AeonDumpManager\Struct\DumpFile;
|
||||||
use Doctrine\DBAL\Connection;
|
use Doctrine\DBAL\Connection;
|
||||||
use League\Flysystem\FilesystemOperator;
|
use League\Flysystem\FilesystemOperator;
|
||||||
|
use Psr\Log\LoggerInterface;
|
||||||
use Shopware\Core\System\SystemConfig\SystemConfigService;
|
use Shopware\Core\System\SystemConfig\SystemConfigService;
|
||||||
use Symfony\Component\Process\Exception\ProcessFailedException;
|
use Symfony\Component\Process\Exception\ProcessFailedException;
|
||||||
use Symfony\Component\Process\Process;
|
use Symfony\Component\Process\Process;
|
||||||
@@ -24,6 +25,7 @@ class DumpService
|
|||||||
private readonly Connection $connection,
|
private readonly Connection $connection,
|
||||||
private readonly SystemConfigService $systemConfigService,
|
private readonly SystemConfigService $systemConfigService,
|
||||||
private readonly DumpFilenameParser $filenameParser,
|
private readonly DumpFilenameParser $filenameParser,
|
||||||
|
private readonly LoggerInterface $logger,
|
||||||
) {
|
) {
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -69,6 +71,7 @@ class DumpService
|
|||||||
}
|
}
|
||||||
|
|
||||||
$this->aeonDumpManagerFilesystemPrivate->delete($path);
|
$this->aeonDumpManagerFilesystemPrivate->delete($path);
|
||||||
|
$this->logger->info('Dump deleted.', ['filename' => $filename]);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -100,6 +103,7 @@ class DumpService
|
|||||||
|
|
||||||
foreach ($excess as $dumpFile) {
|
foreach ($excess as $dumpFile) {
|
||||||
$this->aeonDumpManagerFilesystemPrivate->delete(DumpLister::path($dumpFile->filename));
|
$this->aeonDumpManagerFilesystemPrivate->delete(DumpLister::path($dumpFile->filename));
|
||||||
|
$this->logger->info('Dump removed: maxDumps exceeded.', ['filename' => $dumpFile->filename]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -108,6 +112,7 @@ class DumpService
|
|||||||
foreach ($this->dumpLister->list() as $dumpFile) {
|
foreach ($this->dumpLister->list() as $dumpFile) {
|
||||||
if ($dumpFile->datetime < $threshold) {
|
if ($dumpFile->datetime < $threshold) {
|
||||||
$this->aeonDumpManagerFilesystemPrivate->delete(DumpLister::path($dumpFile->filename));
|
$this->aeonDumpManagerFilesystemPrivate->delete(DumpLister::path($dumpFile->filename));
|
||||||
|
$this->logger->info('Dump removed: older than retention.', ['filename' => $dumpFile->filename]);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -143,6 +148,7 @@ class DumpService
|
|||||||
|
|
||||||
if (!$process->isSuccessful()) {
|
if (!$process->isSuccessful()) {
|
||||||
@unlink($tempPath);
|
@unlink($tempPath);
|
||||||
|
$this->logger->error('Dump process failed.', ['exitCode' => $process->getExitCode()]);
|
||||||
|
|
||||||
throw new ProcessFailedException($process);
|
throw new ProcessFailedException($process);
|
||||||
}
|
}
|
||||||
@@ -153,6 +159,8 @@ class DumpService
|
|||||||
fclose($stream);
|
fclose($stream);
|
||||||
@unlink($tempPath);
|
@unlink($tempPath);
|
||||||
|
|
||||||
|
$this->logger->info('Dump created.', ['filename' => $filename, 'sizeBytes' => $sizeBytes]);
|
||||||
|
|
||||||
return new DumpFile($filename, $dateTime, $sizeBytes);
|
return new DumpFile($filename, $dateTime, $sizeBytes);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
Reference in new issue
Block a user