Skip to content

docs: add plan to sync SDK up to lexicons beta.13#117

Merged
aspiers merged 1 commit into
developfrom
beta.13-spec
Jan 26, 2026
Merged

docs: add plan to sync SDK up to lexicons beta.13#117
aspiers merged 1 commit into
developfrom
beta.13-spec

Conversation

@aspiers
Copy link
Copy Markdown
Contributor

@aspiers aspiers commented Jan 26, 2026

Note

Adds a synchronization plan documenting required SDK updates for lexicon changes through beta.13.

  • Highlights breaking changes: workScope simplified to string | com.atproto.repo.strongRef; measurement schema adds required unit, locations[], dates, comments; rename org.hypercerts.claim.evidenceorg.hypercerts.claim.attachment with new fields and arrays
  • Notes new app.certified.location inline string format support
  • Lists SDK tasks: type updates, method adjustments, docs/examples, tests, and changesets per change
  • Includes final step to bump @hypercerts-org/lexicon to 0.10.0-beta.13 and run full validation checklist

Written by Cursor Bugbot for commit 762eb01. This will update automatically on new commits. Configure here.

Summary by CodeRabbit

  • Documentation
    • Added comprehensive planning document for SDK lexicon synchronization through v0.10.0-beta.13
    • Outlined planned schema updates including workScope simplification, measurement field modifications, evidence-to-attachment renaming, and location string format support
    • Documented breaking changes and validation steps for upcoming releases

✏️ Tip: You can customize this high-level summary in your review settings.

Copilot AI review requested due to automatic review settings January 26, 2026 06:35
@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Jan 26, 2026

⚠️ No Changeset found

Latest commit: 762eb01

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jan 26, 2026

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

A comprehensive specification document is added outlining planned SDK synchronization with lexicon changes from v0.10.0-beta.11 to v0.10.0-beta.13, detailing five major changes: workScope simplification, measurement schema refactoring, evidence-to-attachment rename with schema overhaul, location string format addition, and dependency updates with validation steps.

Changes

Cohort / File(s) Summary
Lexicon Sync Specification
specs/lexicon-sync/v0.10.0-beta.11-v0.10.0-beta.13.md
Introduces comprehensive planning document with five major changes: (1) Simplifies workScope to union of strongRef and string; (2) Refactors measurement schema with unit required, relocates location to locations array, adds date and comment fields; (3) Renames evidence lexicon to attachment with schema overhaul including subjects array and content unions; (4) Adds inline string format option to app.certified.location; (5) Updates @hypercerts-org/lexicon dependency from beta.11 to beta.13 with full validation plan.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

  • updates to match latest lexicons #112 — Overlaps with lexicon synchronization work including workScope, collection, and location changes that form part of the same synchronization lineage.

Poem

🐰 Five changes hopping down the line,
WorkScope simplified, locations align,
Evidence hops to attachment's new name,
Measurement meadows, location's refrain—
Lexicon sync, beta by beta we climb! 🌱


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@aspiers aspiers enabled auto-merge January 26, 2026 06:36
@aspiers aspiers merged commit 97b00d0 into develop Jan 26, 2026
8 of 9 checks passed
@aspiers aspiers deleted the beta.13-spec branch January 26, 2026 06:36
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds comprehensive documentation for syncing the SDK with lexicon schema changes from version 0.10.0-beta.11 to 0.10.0-beta.13. The document provides a detailed step-by-step implementation plan with validation checklists.

Changes:

  • Added a new lexicon sync plan document covering changes from beta.11 to beta.13
  • Documented 5 major changes including work scope simplification, measurement schema refactoring, evidence-to-attachment rename, location string format support, and dependency updates
  • Included detailed SDK tasks, validation steps, and status tracking for each change

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@@ -0,0 +1,266 @@
# Lexicon Sync Plan: v0.10.0-beta.11 → v0.10.0-beta.13
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

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

The PR title states "add plan to sync SDK up to lexicons beta.13" but should use "lexicon" (singular) not "lexicons" (plural) to match the consistent terminology used throughout the codebase and this document. The dependency package is "@hypercerts-org/lexicon" and all references in the document use "lexicon" in singular form.

Copilot uses AI. Check for mistakes.
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