OpenParable
Skip to content
← Back to skills

Shopware Release Docs

Business
shopware-release-docs

Shopware Release Docs is an Agent Skill for business published in the shopware/shopware repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Decide and write Shopware developer-facing release documentation (RELEASE_INFO / UPGRADE / changelog entries). Use when a change may affect extension authors, API consumers, operators, or storefront/theme developers — public APIs, deprecations, removals, configuration, or upgrade steps.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/shopware/shopware/blob/HEAD/.agents/skills/shopware-release-docs/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/shopware-release-docs, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Shopware Release Docs

Document only externally relevant changes.

Decision

Add release documentation when the change affects third-party developers, extension authors, operators, API consumers, or theme/custom storefront developers.

Skip release documentation for narrow local bug fixes, implementation-only refactors, tests-only changes, and client-specific fixes that do not change an external contract.

Where To Write

  • Developer-facing notes: add a concise entry to RELEASE_INFO-6.<minor>.md in the upcoming section and relevant category.
  • Breaking changes, removals, or required migration steps: add the concrete migration path to UPGRADE-6.<next-major>.md.
  • Public REST/Admin/Store API route additions or changes: add or update the matching OpenAPI JSON schema under src/Core/Framework/Api/ApiDefinition/Generator/Schema/<AdminApi|StoreApi>/paths.

Write from the outside user's perspective: what changed, who is affected, and what they should do.