Skip to content

Commit d028b2d

Browse files
committed
refactor migration instructions to improve formating consistency
1 parent 645e6cd commit d028b2d

2 files changed

Lines changed: 8 additions & 4 deletions

File tree

docs/migrations/v0_3_to_v1_0/database/simple_migration.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
This guide is for users who can afford a short period of downtime (typically a few minutes) during the migration from A2A protocol v0.3 to v1.0. This is the recommended path for single-instance applications or non-critical services.
44

5+
---
6+
57
> [!WARNING]
68
> **Safety First:**
79
> Before proceeding, ensure you have a backup of your database.

docs/migrations/v0_3_to_v1_0/database/zero_downtime.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,12 @@ uv run a2a-db --database-url "your-database-url"
4646
> Protocol v1.0 is designed to be backward compatible by default. After this step, your new v1.0 code will be able to read existing v0.3 entries from the database using a built-in legacy parser.
4747
4848
#### ✅ How to Verify
49-
Run `uv run a2a-db current` to ensure the migration was applied successfully.
49+
Confirm the schema is at the correct version:
5050

51-
---
51+
```bash
52+
uv run a2a-db current
53+
```
54+
The output should show the latest revision ID (e.g., `38ce57e08137`).
5255

5356
### Step 2: Rolling Deployment in Compatibility Mode
5457

@@ -83,8 +86,6 @@ Deploy the new code by restarting your instances one by one.
8386
#### ✅ How to Verify
8487
Verify that v1.0 instances are successfully writing to the database. In the `tasks` and `push_notification_configs` tables, new rows created during this phase should have `protocol_version` set to `0.3`.
8588

86-
---
87-
8889
### Step 3: Transition to v1.0 Mode
8990

9091
Once **100%** of your application instances are running v1.0 code (with compatibility mode enabled), you can switch to the v1.0 write format.
@@ -121,6 +122,7 @@ The A2A `DatabaseStore` classes follow a version-aware read/write pattern:
121122

122123
This allows v1.0 instances to read *all* existing data regardless of when it was written.
123124

125+
---
124126

125127
## 🧩 Resources
126128
- **[a2a-db CLI](../../../../src/a2a/migrations/README.md)**: The primary tool for executing schema migrations.

0 commit comments

Comments
 (0)