FreeRTOS 資訊清單檔案指示

需要清單文件才 AWS IoT Device Tester 能識別正在使用的版本和庫。它可協助客戶描述版本、程式庫相依性和中繼資料。

該文件應符合以下要求：

• 這個檔案必須命名為 manifest.yml。

• 它必須位於程式庫或套件的基底資料夾中。

• 它必須是 YAML 格式，並遵循 YAML 1.2 規格。

參數可以是任何順序，但我們建議您按照下列順序放置參數，以獲得最佳的可讀性。在檔案中新增註解，以協助客戶使用您的套件。

檔案路徑

位於套件或程式庫的根目錄。每個封裝只有一個資訊清單檔案。引入的依賴關係可能有自己的清單文件。

參數

name

套件的名稱。所有空格都應該用下劃線（_）替換。例如，My project name - 2020應將變更為My_project_name_-_2020。

• 類型：字串

• 要求：真

• 最小長度:1

• 最大長度：40

version

套件的版本。版本可以是發行版本或版本標籤。

• 類型：字串

• 要求：真

• 最小長度:1

• 最大長度：30

description

封裝的人類可讀描述。描述應清楚地描述包裝是什麼以及它提供的內容。

• 類型：字串

• 要求：真

• 最小長度：30

• 最大長度：

dependencies

使用者成功建置此套件所需的所有第一層相依性清單，並可由 Git、Subversion 或 Mercurial 原始程式碼主機擷取這些套件。請勿包含 Git、SVG 或 hg 無法使用的相依性。請勿包含用於測試、文件產生或開發的相依性。為了促進良好的體驗，我們建議您避免列出門控或私有的依賴關係。

• 類型：數組

• 要求：假

• 最小長度:0

依賴關係 []。

依賴關係的包名稱。這必須與依賴項name參數中找到的包名稱匹配。

• 類型：字串

• 要求：真

• 最小長度:1

• 最大長度：40

依賴關係 []. 版本

相依性的版本。版本可以是發行版本或版本標籤。如果套件本身包含任何相依性，版本必須符合相依性中的資訊清單檔案。

• 類型：字串

• 要求：真

• 最小長度:1

• 最大長度：30

依賴關係 []. 存儲庫

描述相依性原始程式碼的位置。

• 類型：字典

• 要求：真

依賴關係 []. 存儲庫類型

存放庫的類型。

• 類型：字串

• 要求：真

• 枚舉：[混帳，SVN，HG]

依賴關係 [] 存儲庫 .url

存放庫位置的 URL。這必須是具有通訊協定前置詞的完整網址 (例如，https://github.com/ 帳戶名稱/名稱)。

• 類型：字串

• 要求：真

依賴關係 []. 存儲庫. 路徑

專案工作區中相依性的相對路徑。

• 類型：字串

• 要求：真

依賴關係 [] 存儲庫分支

所使用之相依性的分支。如果套件使用程式庫的 release 分支，請勿包含此參數，以將資訊清單的長度保持在最低限度。

• 類型：字串

• 要求：假

license

程式庫的 SPDX 授權識別碼。如需完整清單，請參閱 https://spdx.org/licenses/。它應該匹配包含在存儲庫根目錄中的LICENSE文件（如果存在）。

• 類型：字串

• 要求：真