Skip to content

feat: add compatibility-date #2110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Su (sushmangupta) merged 5 commits into from
Mar 4, 2026
Merged

feat: add compatibility-date #2110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
be965a7
feat: add compatibility-date
shyim Feb 11, 2026
64414a6
Merge branch 'main' into feat/compatibility-date
sushmangupta Mar 3, 2026
10ded28
Update products/cli/project-commands/build.md
sushmangupta Mar 4, 2026
118e0fe
Update products/cli/extension-commands/configuration.md
sushmangupta Mar 4, 2026
e566b0c
Merge branch 'main' into feat/compatibility-date
sushmangupta Mar 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions products/cli/extension-commands/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ Many configurations can be changed using a `.shopware-extension.yml` file in the
Here is an example of a `.shopware-extension.yml` file:

```yaml
compatibility_date: '2026-02-11'

build:
extraBundles:
- path: src/Foo
Expand Down Expand Up @@ -42,6 +44,20 @@ validation:

When you edit that file in an editor, you will get autocompletion and hints for the available options.

## Compatibility date

You can define a `compatibility_date` in `.shopware-extension.yml`:

```yaml
compatibility_date: '2026-02-11'
```

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.

- Format: `YYYY-MM-DD`
- If the field is missing, Shopware CLI uses `2026-02-11` as fallback
- When missing, Shopware CLI logs a warning during config loading

## Environment variables

Additionally, you can set environment variables to change the behavior of the CLI. The following environment variables are available:
Expand Down
16 changes: 16 additions & 0 deletions products/cli/project-commands/build.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,8 @@ All existing environment variables from the parent process are also inherited, s
You can configure the build process with a `.shopware-project.yml` file. The following options are available:

```yaml
compatibility_date: '2026-02-11'

build:
# Browserlist configuration for Storefront
browserslist: 'defaults'
Expand Down Expand Up @@ -190,6 +192,20 @@ build:
post-assets: []
```

## Compatibility date

You can define a `compatibility_date` in `.shopware-project.yml`:

```yaml
compatibility_date: '2026-02-11'
```

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.

- Format: `YYYY-MM-DD`
- If the field is missing, Shopware CLI uses `2026-02-11` as fallback
- When missing, Shopware CLI logs a warning during config loading

## Supporting bundles

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.
Expand Down