Configuring Renovate to properly handle Shopware packages

Renovate is a tool to track your project dependencies and create merge/pull request for them. It works perfectly for most common packages managers, but...

Shopware versioning scheme

Shopware is using a custom versioning scheme. You can read the official article, but in short:

Shopware implemented SemVer as "SemVer with benefits".

A SemVer compliant version has three numbers: Major, Minor, and Patch. They are incremented following this ruleset:

• MAJOR: Incompatible API changes are made
• MINOR: Functionality is added in a backward-compatible manner
• PATCH: Backward-compatible bug fixes are made

The "with benefits" part is: We keep the big marketing number. So Shopware 6 still is the product, but there's a Shopware 6.3.0.0. With 3.0.0 being the SemVer part.

Renovate configuration

The "big marketing number" or "generation" is reflected in Renovate as compatibility

The following configuration will:

1. Group all shopware specific updates
2. Group the updates as shopware
3. Tell Renovate how to extract the version
4. Tell Renovate where to find changelog information

{
  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
  "packageRules": [
    {
      "description": "Follow Shopware version schema",
      "matchDatasources": [
        "packagist"
      ],
      "matchPackageNames": [
        "shopware/core",
        "shopware/administration",
        "shopware/elasticsearch",
        "shopware/storefront"
      ],
      "groupName": "shopware",
      "versioning": "regex:(?<compatibility>\\d+)\\.(?<major>\\d+)(\\.(?<minor>\\d+))?(\\.(?<patch>\\d+))?$",
      "sourceUrl": "https://github.com/shopware/shopware"
    }
  ]
}

This should result in creation of following merge/pull requests

• fix(deps): update shopware (shopware/administration, shopware/core, shopware/elasticsearch, shopware/storefront)`
• fix(deps): update shopware to v7 (major) (shopware/administration, shopware/core, shopware/elasticsearch, shopware/storefront)`