Skip to content

[docs] Docs: clarify hierarchical validation ignore identifiers (shopware-cli#1533) - #2510

Draft
shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/validation-identifier-hierarchy-a7034bcb9d9d2ed0
Draft

[docs] Docs: clarify hierarchical validation ignore identifiers (shopware-cli#1533)#2510
shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/validation-identifier-hierarchy-a7034bcb9d9d2ed0

Conversation

@shopware-docs-updater

Copy link
Copy Markdown
Contributor

This documents a user-facing behavior change from shopware/shopware-cli#1533.

What changed in shopware-cli

Before shopware/shopware-cli#1533, plugin and app metadata validation reported all description and label findings under one shared identifier per field (metadata.description, metadata.label). This made it impossible to ignore a single language or a single rule (e.g. length vs. missing translation) without also hiding every other related finding.

The PR splits these into more specific identifiers:

  • metadata.description.required
  • metadata.description.translation.de-DE / metadata.description.translation.en-GB
  • metadata.description.length.de-DE / metadata.description.length.en-GB
  • metadata.label.translation.de-DE / metadata.label.translation.en-GB

Ignore matching now treats identifiers as a prefix tree: an ignore of metadata.description (or metadata.label) still matches all of its more specific children, preserving backward compatibility for existing .shopware-extension.yml ignore configs.

Documentation gap

products/tools/cli/validation.md documents the validation.ignore config and states "The identifier of a finding is shown in the validation output," but did not explain that identifiers can be matched hierarchically (a broader ignore also suppresses more specific child identifiers). Without this, users trying to ignore a single language/rule combination (per the new granular identifiers) would not know they could use the more specific dotted identifier, or that their existing broad ignore still works.

Documentation files changed

  • products/tools/cli/validation.md — added two sentences under "Validation ignores" explaining hierarchical identifier matching, with the new description/label identifiers as concrete examples.

cc @shyim

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

  • registry.npmjs.org

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "registry.npmjs.org"

See Network Configuration for more information.

Generated by 📝 PR documentation check for #1533 · copilot · auto · 49 AIC · ⌖ 7.07 AIC · ⊞ 7.7K ·

@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Sep 11, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: 5df7883
Preview: https://developer-documentation-ltvewpkff-shopware-frontends.vercel.app
Workflow run: #5268

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

0 participants