Skip to content

docs: fix what merge() does in the entity versioning guide - #2628

Merged
Su (sushmangupta) merged 3 commits into
mainfrom
fix/docs-versioning-entities-merge-behavior
Oct 23, 2026
Merged

Su (sushmangupta) merged 3 commits into
mainfrom
fix/docs-versioning-entities-merge-behavior

Conversation

@d-kirkland

@d-kirkland Daniel Kirkland (d-kirkland) commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • versioning-entities.md describes merge in two places: line 55 says "all versions before the merged version are deleted", and line 112 says merge "deletes all versions before this one", followed on line 113 by "The merged version is now our new live version."
  • In VersionManager::merge() the target is the version of the context that is passed in ($targetVersionId = $writeContext->getContext()->getVersionId();, L169). The merged version's changes are written into that target (executeWrites($writes, $targetContext)), and deleteClones() then removes the records that carry the merged $versionId. updateVersionData() also deletes the merged version itself (// delete version). Nothing in merge() deletes other versions.
  • A reader would believe that merging removes earlier versions and that the merged version itself becomes the live one. In fact the data is copied into the target version (in the example, the original context's version, which is the live one) and the merged version is deleted together with its records.
  • This PR rewrites the sentence on line 55 and the sentences on lines 112-113 to say that, in the terms merge() uses. No other lines change.

Related links

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant. (Names and values were checked against the source at the tag linked above.)
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted. (N/A, no page moved.)
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms. (No new prose words.)
  • Any required dependent changes in downstream modules have already been merged and published. (N/A)
  • This pull request is ready for review.

Notes

  • This PR was fully AI generated (Claude Code) and requires human review. It has not been merged, approved or reviewed by the AI session. Please verify the claims and the changed text against the source before merging.
  • Defect type: Wrong fact. The page states what merge deletes and which version becomes the live one. VersionManager::merge() does something different: it writes the merged version's changes into the version of the context passed in and deletes the merged version together with its records.
  • Codebase files this change was checked against (tag v6.7.15.1): src/Core/Framework/DataAbstractionLayer/VersionManager.php L169-L169; src/Core/Framework/DataAbstractionLayer/VersionManager.php L203-L210; src/Core/Framework/DataAbstractionLayer/VersionManager.php L993-L995; src/Core/Framework/DataAbstractionLayer/VersionManager.php L969-L970.
  • How it was found: an automated audit of this page against shopware/shopware at tag v6.7.15.1, then two independent AI verification passes that re-read the page and the cited source files. Please check the cited lines yourself before merging.
  • Scope: main (Shopware 6.7) only. Older docs branches are not touched.

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@d-kirkland Daniel Kirkland (d-kirkland) added Improvement PR created to append/modify info in the existing article Info Missed To Document Info Missed To Document labels Oct 16, 2026
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with failure.
Repository: shopware/docs
Commit: 983cd79
Preview: No Vercel preview URL was found in the workflow logs.
Workflow run: #5828

@shopware-dev-docs-connector

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Running.
Repository: shopware/docs
Commit: 3a89134
Preview: Waiting for workflow logs.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown
Contributor

📢 Developer Announcement Recommendation

Recommendation: ❌ No Announcement Recommended

No developer announcement signals were detected.

This PR does not appear to introduce developer-facing changes that require a community announcement.

@sushmangupta
Su (sushmangupta) merged commit 2c0f1ad into main Oct 23, 2026
9 of 10 checks passed
@sushmangupta
Su (sushmangupta) deleted the fix/docs-versioning-entities-merge-behavior branch October 23, 2026 12:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Improvement PR created to append/modify info in the existing article Info Missed To Document Info Missed To Document

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants