docs: add CHANGELOG and MIGRATION guide for the review batch#176
Merged
Conversation
The recent batch landed 29 PRs touching security, performance, the test foundation and a god-class decomposition. Without a changelog it is hard to discover what's new, and without a migration note it is hard for consumers to know which capabilities are opt-in. CHANGELOG.md follows the Keep a Changelog format. The Unreleased section groups the work into Security / Performance / Added / Changed / Fixed / Tooling / Closed-without-change, with cross-references to the originating issues and the PRs that landed each item. MIGRATION.md walks a consumer of the package through what they need to know in practice — the everything-is-backwards-compatible promise, plus how to opt-in to each new safeguard: - scopeQuery() for row-level authorization - FileField::allowedMimeTypes() for MIME whitelisting - HtmlSanitizer when rendering RichText outside the package's view - global search tunables - BuildoraAbility enum - the resource trait decomposition (no code change needed) - field-type bug fixes worth knowing about Both files describe code that is currently on feature branches; nothing is wired into the package's release tooling. When the batch merges, the [Unreleased] section becomes the next version entry.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Wat
Twee nieuwe documentatie-bestanden om de 29 PRs van deze review-batch overzichtelijk te maken voor reviewers, package-consumers, en het release-proces.
CHANGELOG.md— Keep a Changelog format[Unreleased]section ingedeeld per categorie:Elke entry cross-referenced naar het originating issue én de PR die het landt.
MIGRATION.md— consumer-side notesPraktische handleiding voor wie het package upgrade na merge. Belangrijkste onderdelen:
scopeQuery()voor record-level auth, met copy-pasteable voorbeeldFileField::allowedMimeTypes()MIME whitelistHtmlSanitizerdirecte call wanneer rich text in custom views gerenderd wordtBuildoraAbilityenum optionele migratieWanneer dit wordt opgepakt door release tooling
De
[Unreleased]sectie wordt de eerste echte versie-entry bij merge naarmain+ tag. Niets wired in CI nu — dit is een document-only PR.Verificatie
Refs
Alle PR-nummers in CHANGELOG.md: #144, #146-#159, #161-#175 (29 totaal). Closed-without-change issues: #125, #128, #132, #133, #141.