Skip to content

[docs] Rename sw-cli checker references to builtin - #2556

Closed
shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/sw-cli-builtin-rename-0016b56c996ec250
Closed

shopware-docs-updater[bot] wants to merge 1 commit into
mainfrom
docs/sw-cli-builtin-rename-0016b56c996ec250

Conversation

@shopware-docs-updater

Copy link
Copy Markdown
Contributor

Warning

Threat Detection Engine Failure — The analysis engine could not complete. This is a tooling failure, not a security finding.

What happened

The threat detection engine failed to produce results.

Review the workflow run logs for details.

What changed?

Updates CLI documentation references to the built-in extension validation checker, renamed from sw-cli to builtin in shopware/shopware-cli#1627 (by @MalteJanz).

sw-cli remains accepted as a legacy alias for --only/--exclude in the CLI but now triggers a deprecation warning, so the docs now consistently use builtin while noting the alias.

Why?

sw-cli was a documented, user-facing tool identifier (used in --only/--exclude, tool tables, and command examples). Its rename to builtin is a public-behavior change that needed reflecting in the developer docs to avoid guiding users to a deprecated name.

Files changed

  • products/tools/cli/validation.md — updated basic-mode description, tool table, "which tools each command runs" table, and the project validate warning; added a note about the sw-cli legacy alias and deprecation warning.
  • products/tools/cli/index.md — updated the "basic extension validate" mention.
  • products/tools/cli/automatic-refactoring.md — updated the list of tools that report findings during validation.

Not changed: products/tools/cli/project-commands/image-proxy.md's zzz-sw-cli-image-proxy.yml filename is unrelated (a generated config filename, not the verifier tool name).

Source PR: shopware/shopware-cli#1627

Generated by 📝 PR documentation check for #1627 · copilot · auto · 51.2 AIC · ⊞ 7.9K · ◷

Reflects shopware/shopware-cli#1627, which renamed the built-in
extension validation checker from 'sw-cli' to 'builtin'. The old
name remains accepted as a legacy alias for --only/--exclude but
now emits a deprecation warning.

@shopware-docs-updater shopware-docs-updater Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Threat detection produced a warning for this pull request output.

These changes need to be scrutinized before merge and only merged after a careful manual review.

@shopware-dev-docs-connector

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Running.
Repository: shopware/docs
Commit: 97b0421
Preview: Waiting for workflow logs.

@MalteJanz

Copy link
Copy Markdown
Contributor

part of #2547

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant