Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,6 @@ coverage
.github/copilot-instructions.md
*.md
!README.md
!migration-guide.md
*.yaml
!config.yaml
54 changes: 54 additions & 0 deletions migration-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 🚨 Breaking Change Release — v3.0.0

## 🔑 Breaking Changes

### 1. Explicit flag syntax

* **Long-form flags** must now use `--` (e.g., `--profile`).
* **Short-form flags** must now use `-` (e.g., `-p`).

---

### 2. `config` now means “application configuration”

* `config` now refers to the **application’s own configuration** (Go-standard).
* `configv2` has been **removed**.

---

### 3. Old `config` → now called `profile`

* The concept of `config` used for provisioning (previously passed as `configv2`) is now called a **profile**.
* Use the `--profile` flag to provide this, aligning with the rest of the device-management-toolkit.

---

## 🚀 Migration Examples

### Example: Switching from `configv2` to `--profile`

**Before (v2.x):**

```bash
rpc-go configure --configv2 path/to/profile.yaml
```

**After (v3.0):**

```bash
rpc-go configure --profile path/to/profile.yaml
# or, where supported:
rpc-go configure -p path/to/profile.yaml
```



## ✅ Summary

* **Flags must be explicit** (`--long`, `-s`).
* **`config` = app configuration**.
* **`configv2` removed**.
* **`--profile` replaces `configv2`**.

---