Skip to content
Snippets Groups Projects
Commit 30d5b9c2 authored by James Briggs's avatar James Briggs
Browse files

fix: update release workflow and add migrration info

parent c77d219a
No related branches found
No related tags found
No related merge requests found
name: Release Docs name: Release Docs
on: on:
release: push:
types: [ released ] branches:
- main
jobs: jobs:
build-docs: build-docs:
......
Migration Guide for v0.1.0 Migration Guide for v0.1.0
========================== ==========================
The v0.1 release of semantic router introduces a few breaking changes. This guide will
help you migrate your code to the new version.
- `from semantic_router import RouteLayer` -> `from semantic_router.routers import SemanticRouter` - `from semantic_router import RouteLayer` -> `from semantic_router.routers import SemanticRouter`
- `SemanticRouter.add(route: Route)` -> `SemanticRouter.add(routes: List[Route])` - `SemanticRouter.add(route: Route)` -> `SemanticRouter.add(routes: List[Route])`
- If expecting routes to sync between local and remote on initialization, use `SemanticRouter(..., auto_sync="local")`. Read more about `auto_sync` and :doc:`synchronization strategies <route-layer/sync>`. - If expecting routes to sync between local and remote on initialization, use `SemanticRouter(..., auto_sync="local")`. Read more about `auto_sync` and :doc:`synchronization strategies <semantic-router/route-layer/sync>`.
\ No newline at end of file \ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment