Skip to content

docs: add v0.16 upgrade guide#811

Merged
alexluong merged 9 commits intomainfrom
docs/upgrade-v0.16
Apr 10, 2026
Merged

docs: add v0.16 upgrade guide#811
alexluong merged 9 commits intomainfrom
docs/upgrade-v0.16

Conversation

@alexluong
Copy link
Copy Markdown
Collaborator

@alexluong alexluong commented Apr 8, 2026

Summary

  • Add upgrade guide for v0.16 covering breaking changes:
    • Webhook signing defaults changed (whsec_ prefix, simplified signature header)
    • Event destination_id replaced with matched_destination_ids
    • Delivery metadata timestamp format switched from Unix to ISO 8601
    • response_data.body is now always a string (previously parsed JSON objects were stored as nested objects) — see fix: store HTTP response body as raw string #723
    • attempts.response_data column migrated from JSONB to TEXT (migration 000009) — serialization now handled in application code, consistent with events.data and attempts.event_data
  • Register guide in sidebar nav and guides index page

Note

PR #723 adds two additional breaking changes that should be included in the v0.16 upgrade guide:

  1. API: response_data.body is now always a raw string, even when the destination returns application/json. Previously, JSON response bodies were parsed into objects.
  2. Database: attempts.response_data column is migrated from JSONB to TEXT (migration 000009). Queries that traverse into response_data via JSON operators (e.g., response_data->'body'->>'key') will stop working.

🤖 Generated with Claude Code

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 8, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
outpost-docs Ready Ready Preview, Comment Apr 9, 2026 9:27am
outpost-website Ready Ready Preview, Comment Apr 9, 2026 9:27am

Request Review

alexluong and others added 6 commits April 8, 2026 21:45
Cover breaking changes: webhook signing defaults (whsec_ prefix,
simplified signature header), event destination_id → matched_destination_ids,
and delivery metadata timestamp format (Unix → ISO 8601).

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Signature content/header template changes were from a prior release.
Only the whsec_ secret prefix is new in v0.16.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
ALERT_CALLBACK_URL removed in favor of OPERATION_EVENTS_* config.
Alert defaults changed (failure count 20→100, auto-disable true→false).
Redis key scoping is internal, not user-facing.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
New operation events docs cover configuration (topics, sinks),
event envelope, all 4 event payloads, and delivery guarantees.
Alerts page updated to point to operation events for receiving alerts.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should really just remove this no?

alexluong and others added 2 commits April 9, 2026 16:23
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Per review feedback — alerts are now fully covered by the
operation events page. Update cross-references accordingly.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@alexluong alexluong merged commit 8160d43 into main Apr 10, 2026
4 checks passed
@alexluong alexluong deleted the docs/upgrade-v0.16 branch April 10, 2026 16:56
alexluong added a commit that referenced this pull request Apr 10, 2026
Ports the v0.16 upgrade guide from #811 into the new Markdoc-based
docs structure. Adapts "operation events" prose to "operator events"
to match the naming decision on feat/refactor-docs; env vars remain
OPERATION_EVENTS_* as defined in code.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
alexluong added a commit that referenced this pull request Apr 10, 2026
Ports the v0.16 upgrade guide from #811 into the new Markdoc-based
docs structure. Adapts "operation events" prose to "operator events"
to match the naming decision on feat/refactor-docs; env vars remain
OPERATION_EVENTS_* as defined in code.

Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants