docs: add CHANGELOG.md#120
Merged
Merged
Conversation
Closes #102 Repo had no CHANGELOG.md; users had to read GitHub release notes to find what changed between versions. With v1 ahead and a queue of breaking changes (#86, #87, #88, #89, #90, #91, #104), having a CHANGELOG before landing those gives downstream code reviewers and IDEs visibility into what's coming. Format follows Keep a Changelog 1.1.0 with the standard six headings (Added / Changed / Deprecated / Removed / Fixed / Security). [Unreleased] section captures the run of merged-but-not-released PRs since v0.7.0: - #103 polyscript.New[E] generic constructor (deprecates 12 FromXxx) - #105 slog.Handler optional in engine subpackages - #106 RequestToMap mutation fix - #107 HTTP loader MaxBodySize cap - #110 unify nil-handler on slog.Default(); drop stdout fallbacks - #113 WithLogHandler(nil)/WithLogger(nil) → no-op - #114 drop redundant nil-guards; tighten WithLogHandler doc - #115 docs/LOGGING.md - #117 fix bare top-level json.Number leak - #118 WithGlobals additive; drop dead URL check - #119 extism Eval test coverage Backfilled the three releases the issue called out (v0.5.0, v0.6.0, v0.7.0) from existing GitHub release notes, sorted into Keep a Changelog categories. Earlier releases (v0.0.x through v0.4.0) intentionally not backfilled per the issue scope; can be added in a follow-up if desired. Out of scope: the optional CI gate that fails PRs not touching CHANGELOG.md. Adds noise to small bug PRs and wants opt-out-label infrastructure to support it; better as a separate issue.
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a root-level CHANGELOG.md to document notable changes in a Keep a Changelog–compatible format, improving visibility into unreleased and recent released changes without requiring users to consult GitHub release notes.
Changes:
- Introduces
CHANGELOG.mdfollowing Keep a Changelog 1.1.0 structure, including an[Unreleased]section. - Backfills changelog entries for releases
0.5.0,0.6.0, and0.7.0, and adds compare links.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ### Changed | ||
| - `slog.Handler` is now optional throughout. A nil handler at any layer | ||
| inherits from `slog.Default()` via the canonical `helpers.SetupLogger` | ||
| helper; no constructor demands a handler. |
…dler Copilot review noted that "no constructor demands a handler" is misleading because the deprecated FromXxx constructors still take a positional `logHandler slog.Handler` argument (even though nil is accepted). Reword to distinguish the new generic constructor (no handler arg) from the deprecated ones (still take it, but nil is OK).
|
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
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.
Summary
Adds
CHANGELOG.mdat the repo root following Keep a Changelog 1.1.0.The repo had no
CHANGELOG.md; users had to read GitHub release notes to find what changed between versions. With v1 ahead and a queue of breaking changes (#86, #87, #88, #89, #90, #91, #104), having a CHANGELOG before landing those gives downstream code reviewers and IDEs visibility into what's coming.[Unreleased]sectionCaptures the run of merged-but-not-released PRs since
v0.7.0:polyscript.New[E]generic constructor (deprecates 12FromXxx)slog.Handleroptional in engine subpackagesRequestToMapmutation fixMaxBodySizecapslog.Default(); drop stdout fallbacksWithLogHandler(nil)/WithLogger(nil)→ no-opWithLogHandlerdocdocs/LOGGING.mdjson.NumberleakWithGlobalsadditive; drop dead URL checkSorted into Keep-a-Changelog categories (Added / Changed / Deprecated / Removed / Fixed).
Backfill
Backfilled the three releases the issue called out (
v0.5.0,v0.6.0,v0.7.0) from the GitHub release notes viamcp__github__list_releases, sorted into the same categories. Thev0.7.0Risor v2 upgrade is flagged as BREAKING in its Changed entry.Earlier releases (
v0.0.xthroughv0.4.0) intentionally not backfilled per the issue scope; can be added in a follow-up if desired.Out of scope
CHANGELOG.md. Adds noise to small-bug PRs and wants opt-out-label infrastructure to support it; better as a separate issue.Test plan
CHANGELOG.mdrenders correctly on GitHub (no broken markdown, version anchors at bottom resolve to compare URLs)go build ./...— no code change, but verifies repo stateCloses #102
https://claude.ai/code/session_01C61VEAmjxSnX5Xhbab8NvL
Generated by Claude Code