Skip to content

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

text
MAJOR.MINOR.PATCH

MAJOR: 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.13.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.32.2.0 (PATCH reset to 0).

PATCH: Bug fixes

Backwards-compatible fixes:

  • Styling corrections
  • Performance optimisations
  • Non-functional improvements

Example: 2.1.12.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.

PluginChangelog sources
DmfGuppyThemeGitLab tags, CHANGELOG.md
DmfAutoStyleguideCHANGELOG.md
DmfSplideSliderCHANGELOG.md
Other pluginsGitLab tags + plugin composer.json version

Shopware update workflow

1. Read Shopware UPGRADE.md

Shopware publishes an UPGRADE.md with breaking changes per release:

bash
curl -s https://raw.githubusercontent.com/shopware/platform/trunk/UPGRADE.md

2. Automated compatibility check

DmfGuppyTheme ships a scanner:

bash
# 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
OptionDescription
--shopware-versionTarget Shopware version (e.g. 6.7.0)
--target-versionTarget Guppy version
--formattable, json, yaml
--output-fileWrite the report to a file
--verboseDetailed debug output

3. Run the update

bash
composer update dmf/sw6-guppy-theme
bin/console plugin:refresh
bin/console plugin:update DmfGuppyTheme
bin/console theme:compile
bin/console cache:clear

theme: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 / tagWhen to use
Tagged version (e.g. v2.6.0)production
RC tag (e.g. v2.8.0-rc1)testing upcoming Shopware major versions
mainintentional "latest stable without tag", rarely in production
stagetesting environments only

Details: Contributing.

CI integration

Example .gitlab-ci.yml step for a weekly upgrade check:

yaml
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.json

Hotfixes

Outside of regular releases, critical bug fixes ship as PATCHes. Workflow details: Contributing → Hotfixes.