Skip to content

Commit be965a7

Browse files
committed
feat: add compatibility-date
1 parent d939334 commit be965a7

2 files changed

Lines changed: 32 additions & 0 deletions

File tree

products/cli/extension-commands/configuration.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Many configurations can be changed using a `.shopware-extension.yml` file in the
1212
Here is an example of a `.shopware-extension.yml` file:
1313

1414
```yaml
15+
compatibility_date: '2026-02-11'
16+
1517
build:
1618
extraBundles:
1719
- path: src/Foo
@@ -42,6 +44,20 @@ validation:
4244
4345
When you edit that file in an editor, you will get autocompletion and hints for the available options.
4446
47+
## compatibility_date
48+
49+
You can define a `compatibility_date` in `.shopware-extension.yml`:
50+
51+
```yaml
52+
compatibility_date: '2026-02-11'
53+
```
54+
55+
The `compatibility_date` lets Shopware CLI introduce behavior changes without breaking existing projects by default. New or potentially breaking changes are activated only for configurations that opt in with a date at or after the feature's rollout date.
56+
57+
- Format: `YYYY-MM-DD`
58+
- If the field is missing, Shopware CLI uses `2026-02-11` as fallback
59+
- When missing, Shopware CLI logs a warning during config loading
60+
4561
## Environment variables
4662

4763
Additionally, you can set environment variables to change the behavior of the CLI. The following environment variables are available:

products/cli/project-commands/build.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -105,6 +105,8 @@ MJML compilation requires the `mjml` package to be installed via NPM in your bui
105105
You can configure the build process with a `.shopware-project.yml` file. The following options are available:
106106

107107
```yaml
108+
compatibility_date: '2026-02-11'
109+
108110
build:
109111
# Browserlist configuration for Storefront
110112
browserslist: 'defaults'
@@ -134,6 +136,20 @@ build:
134136
- custom/static-plugins
135137
```
136138

139+
## compatibility_date
140+
141+
You can define a `compatibility_date` in `.shopware-project.yml`:
142+
143+
```yaml
144+
compatibility_date: '2026-02-11'
145+
```
146+
147+
The `compatibility_date` lets Shopware CLI introduce behavior changes without breaking existing projects by default. New or potentially breaking changes are activated only for configurations that opt in with a date at or after the feature's rollout date.
148+
149+
- Format: `YYYY-MM-DD`
150+
- If the field is missing, Shopware CLI uses `2026-02-11` as fallback
151+
- When missing, Shopware CLI logs a warning during config loading
152+
137153
## Supporting bundles
138154

139155
Shopware CLI automatically detects plugins and Apps. Custom bundles (classes that extend bundle class from Shopware) cannot be automatically detected as Shopware CLI does not execute any PHP code.

0 commit comments

Comments
 (0)