Pre-release sweep: reconcile v0.14.0 changelog and example docs#159
Merged
Conversation
Pre-release sweep for the upcoming v0.14.0 cycle (no version bump; that lands with the release commit). Changelog: record the FailureIsolatedEvent.attempt_index behavior in a failure-isolation-wraps-retry composition (it reports the final exhausting attempt), which was the one user-visible change since v0.13.0 not yet captured. Reword the two proposal-0050 "pin unchanged" notes to be 0050-scoped so they no longer read as contradicting the cycle's consolidated pin-advance entry. Example docs: the illustrative observability output pinned the spec_version and implementation.version; replace both with placeholders so the snapshots stop going stale on every pin bump and release. Those values are release-varying, unlike the run-varying numbers the block already shows as placeholders.
There was a problem hiding this comment.
Pull request overview
Docs/changelog reconciliation ahead of the v0.14.0 tag, ensuring the Unreleased changelog accurately reflects recent behavior and example observability output doesn’t go stale due to pinned version strings.
Changes:
- Updated the Unreleased changelog entry for
FailureIsolationMiddlewareto documentFailureIsolatedEvent.attempt_indexbehavior when composed outer ofRetryMiddleware. - Reworded proposal-0050 “pin unchanged” phrasing to avoid contradicting the cycle’s consolidated spec pin advance language.
- Replaced hardcoded
spec_versionandimplementation.versionvalues in example observability outputs with placeholders.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/examples/production-observability.md | Replaces pinned spec/impl versions in the OTel example output with placeholders. |
| docs/examples/langfuse-observability.md | Replaces pinned spec_version in the Langfuse example output with a placeholder. |
| CHANGELOG.md | Updates Unreleased “Added” entries to reflect the attempt_index behavior and clarifies 0050 pin wording. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Pre-release reconciliation for the v0.14.0 cycle, ahead of tagging. No version bump (that lands with the
chore(release)commit); this is docs + changelog only.Changelog
FailureIsolatedEvent.attempt_indexbehavior in a failure-isolation-wraps-retry composition (it reports the wrapped node's final, exhausting attempt). This was the one user-visible change since v0.13.0 (Fix failure-isolation event attempt_index #155) not yet reflected in the Unreleased section; folded into theFailureIsolationMiddlewareentry.Example docs
The illustrative observability output in
production-observability.mdandlangfuse-observability.mdpinnedspec_versionandimplementation.versionto concrete values, which went stale on every pin bump and release (touched twice already this cycle). Replaced them with<spec-version>/<version>placeholders, consistent with the<uuid>/...placeholders those same blocks already use for run-varying values. The constant parts (implementation.name, the attribute names) stay concrete.Audit result
The CHANGELOG is now complete against all ten PRs since v0.13.0;
conformance.tomlis current (pin v0.55.1, 0065implemented, 60/60 manifest). The actual version bump and changelog date land in the separate release commit, gated on the v0.14.0 tag decision.Validation
uv run mkdocs build: cleanuv run pytest tests/: 1298 passed (unchanged; prose-only edits)