docs: document shopware-cli project sbom command - #2394
docs: document shopware-cli project sbom command#2394RoboShyim (roboshyim) wants to merge 3 commits into
Conversation
Add a project-commands page for `shopware-cli project sbom`, list it under Command Types, link from project ci build docs, and mention it in the development tooling overview. Related: shopware/shopware-cli#1246 / shopware#1239
Developer Docs healthcheckStatus: Running. Fork PRs need approval from a maintainer with write access before the healthcheck can run. GitHub approves only the latest commit, so every new commit pushed after approval needs another approval. |
Micha Hobert (Isengo1989)
added
the
Undocumented Feature
There was a problem hiding this comment.
Pull request overview
This PR adds documentation for the new shopware-cli project sbom command (as introduced in shopware/shopware-cli#1246), and integrates it into existing CLI command overviews and related pages.
Changes:
- Adds a new documentation page for
shopware-cli project sbom, including usage examples, option reference, and relation toproject ci. - Updates existing CLI docs to mention/link the SBOM output and the new standalone command.
- Extends the spellcheck wordlist with CycloneDX/SBOM-related terms.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| products/tools/cli/project-commands/sbom.md | New command page describing SBOM generation, usage, options, and relation to project ci. |
| products/tools/cli/project-commands/build.md | Notes that project ci writes an SBOM and links to the new standalone project sbom command docs. |
| products/tools/cli/command-types.md | Adds project sbom to the “Project commands” list. |
| guides/development/tooling/index.md | Adds project sbom to the tooling choice table for “Generating a project SBOM”. |
| .wordlist.txt | Adds CycloneDX/SBOM-related terms to avoid spellcheck failures. |
Comments suppressed due to low confidence (1)
products/tools/cli/project-commands/sbom.md:44
- The command options table is not introduced with a complete sentence. Our documentation guidelines require introducing tables with a sentence that refers to the table position (e.g., “the following table”).
## Command options
| Option | Description | Default |
|---|---|---|
| `[path]` | Shopware project directory | Nearest project / working directory |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
|
Micha Hobert (@Isengo1989) can we merge this 👀 ? |
|
Copilot resolve the merge conflicts in this pull request |
Summary
Documents the new
shopware-cli project sbomcommand requested on shopware/shopware-cli#1246.Changes
products/tools/cli/project-commands/sbom.md(usage, options, relation toproject ci)command-types.md— listproject sbomproject-commands/build.md— note that CI writes an SBOM; link to standalone commandguides/development/tooling/index.md— tooling choice table row.wordlist.txt— CycloneDX / SBOM termsRelated
project sbomcommand shopware-cli#1246project sbomcommand shopware-cli#1239