Changelog
Guppy and all Guppy plugins strictly follow Semantic Versioning. This page describes the versioning rules, the update workflow, and where to find official release notes.
SemVer scheme
MAJOR.MINOR.PATCHMAJOR: Breaking changes
Incompatible changes requiring manual adjustments:
- Template blocks removed or renamed
- Configuration options removed
- CSS classes fundamentally changed
- JavaScript plugin APIs changed
Example: 2.6.1 → 3.0.0 (MINOR and PATCH reset to 0).
MINOR: New features
Backwards-compatible functionality:
- New template blocks or properties
- New configuration options
- Additional CSS classes
- New JavaScript plugin features
Example: 2.1.3 → 2.2.0 (PATCH reset to 0).
PATCH: Bug fixes
Backwards-compatible fixes:
- Styling corrections
- Performance optimisations
- Non-functional improvements
Example: 2.1.1 → 2.1.2.
Release notes per plugin
Because Guppy spans multiple plugins, the official release notes live per plugin in each GitLab repository under Releases. Several plugins additionally ship a local CHANGELOG.md in English.
| Plugin | Changelog sources |
|---|---|
| DmfGuppyTheme | GitLab tags, CHANGELOG.md |
| DmfAutoStyleguide | CHANGELOG.md |
| DmfSplideSlider | CHANGELOG.md |
| Other plugins | GitLab tags + plugin composer.json version |
Shopware update workflow
1. Read Shopware UPGRADE.md
Shopware publishes an UPGRADE.md with breaking changes per release:
curl -s https://raw.githubusercontent.com/shopware/platform/trunk/UPGRADE.md2. Automated compatibility check
DmfGuppyTheme ships a scanner:
# scan all installed components
bin/console guppy:upgrade:scan
# against a specific Shopware target version
bin/console guppy:upgrade:scan --shopware-version=6.7.0
# write a report to a file
bin/console guppy:upgrade:scan --format=json --output-file=upgrade-report.json| Option | Description |
|---|---|
--shopware-version | Target Shopware version (e.g. 6.7.0) |
--target-version | Target Guppy version |
--format | table, json, yaml |
--output-file | Write the report to a file |
--verbose | Detailed debug output |
3. Run the update
composer update dmf/sw6-guppy-theme
bin/console plugin:refresh
bin/console plugin:update DmfGuppyTheme
bin/console theme:compile
bin/console cache:cleartheme:compile required
After a plugin update, run theme:compile, otherwise neither new SCSS values nor Twig changes take effect.
Branching as a source of updates
| Branch / tag | When to use |
|---|---|
Tagged version (e.g. v2.6.0) | production |
RC tag (e.g. v2.8.0-rc1) | testing upcoming Shopware major versions |
main | intentional "latest stable without tag", rarely in production |
stage | testing environments only |
Details: Contributing.
CI integration
Example .gitlab-ci.yml step for a weekly upgrade check:
upgrade-check:
rules:
- if: $CI_PIPELINE_SOURCE == "schedule"
script:
- composer install
- bin/console guppy:upgrade:scan --format=json --output-file=upgrade-report.json
artifacts:
paths:
- upgrade-report.jsonHotfixes
Outside of regular releases, critical bug fixes ship as PATCHes. Workflow details: Contributing → Hotfixes.
Related
- Contributing: branch strategy and workflow.
- Architecture:
guppy:upgrade:scanand other console commands.