Skip to content

元件更新與版本管理

迭代已發佈元件的版本、修正問題或新增功能。

更新流程

1. 下載元件

前往「我的元件」,找到需要更新的元件並點擊「更新」按鈕。在更新頁面上:

  1. 點擊「下載」取得目前版本
  2. 選擇儲存路徑(專案的元件目錄)
  3. 確認下載完成

2. 本機修改

在您的專案中開啟下載的元件資料夾並進行修改:

  • 修正錯誤
  • 新增功能
  • 最佳化效能
  • 更新文件

3. 測試與驗證

在本機環境中測試修改後的元件,確保:

  • 原有功能正常運作
  • 新功能如預期運作
  • 無控制台錯誤

4. 上傳更新

返回 comp-hub 的更新頁面:

  1. 選擇修改後的元件資料夾
  2. 更新版本號(如果檔案內容有變更)
  3. 調整預覽設定(如有需要)
  4. 修改元件描述(建議說明變更內容)
  5. 點擊「更新」發佈

版本號規範

元件版本遵循語意化版本規範:

major.minor.patch
版本類型變更內容範例
修補版本修正錯誤、向後相容1.0.0 → 1.0.1
次要版本新增功能、向後相容1.0.0 → 1.1.0
主要版本破壞性變更1.0.0 → 2.0.0

何時需要更新版本號

必須更新

  • 修改了元件程式碼(.vue 檔案)
  • 變更了元件 props 介面
  • 調整了元件行為邏輯

無需更新

  • 僅修改預覽設定
  • 僅更新元件描述

如何修改版本號

方式一:在更新頁面修改(推薦)

在元件更新頁的設定區,直接修改版本號輸入框,系統會自動更新 comp.json 檔案。

方式二:本機手動修改

在本機專案的 comp.json 中手動修改版本號:

json
{
  "name": "MyComponent",
  "version": "1.1.0"
}

版本管理

多版本並存

平台保留元件的所有歷史版本。使用者可以:

  • 在預覽頁切換查看不同版本
  • 下載和使用任何歷史版本
  • 比較版本之間的差異

最佳實務

變更日誌

在元件的 README.md 中維護變更日誌:

markdown
## Changelog

### 1.1.0 (2024-01-15)

- Added: Support for custom theme colors
- Optimized: Improved rendering performance with large data volumes

### 1.0.1 (2024-01-10)

- Fixed: Fixed tooltip not displaying in certain situations

### 1.0.0 (2024-01-01)

- Initial version release

向後相容

  • 盡量保持 props 介面穩定
  • 如果需要棄用某個屬性,請先在文件中標記為已棄用
  • 破壞性變更必須升級主版本號

使用者上傳的元件遵循開源協議