目录结构规范

更新时间:
2024-12-31

目录结构规范

为了确保软件包的规范性、可移植性,以及在不同环境中的顺利部署、安装、升级和卸载,软件包应遵循一定的目录结构规范。推荐参考 创建软件包 来自动生成符合规范的目录结构,并将待发布的文件放置在根目录下。此外,您也可以手动创建一个以软件包名称命名的文件夹,该文件夹应包含以下内容:

  • 包含待发布的软件包文件集合,可以是具体的文件或文件夹。如果涉及多平台和多架构,建议将具体的包文件放置在以平台和架构命名的子文件夹中,或在文件名中包含平台和架构信息。
  • 必须包含一个名称为 armory.json 的配置文件,用于发布软件包,并配置待发布软件包的详细信息,如软件包名称、版本、描述、检索标签、包资源路径等。
  • 建议包含 README 文件,用于详细描述软件包的编译、安装、配置、使用指导和更新日志等对用户有用的必要信息,README 文件的后缀必须为“.md”或“.txt”,且必须将其放置在软件包根目录下。
  • 如果 README 文件中有引用图片资源,建议将图片放置在软件包根目录的“assets/image”路径下。

下面以 armory-cli 软件包为例介绍软件包的目录结构及相关要求:

|-- armory-cli
    |-- assets
        |-- image
            |-- macos.png
            |-- windows.png
    |-- armory.json
    |-- README.md
    |-- windows
        |-- x86-64
            |-- armory-win-x64.exe
        |-- arm64
            |-- armory-win-arm64.exe                      
    |-- linux
        |-- x86-64
            |-- armory-linux-x64
    |-- macos
        |-- arm64      
            |-- armory-macos
|-- armory-cli
    |-- assets
        |-- image
            |-- macos.png
            |-- windows.png
    |-- armory.json
    |-- README.md
    |-- armory-win-x64.zip
    |-- armory-win-arm64.zip
    |-- armory-linux-x64.tar.gz
    |-- armory-macos-arm64.tar.gz

目录结构说明如下:

文件名是否必配说明
armory-cli软件包根目录,对应软件包名称,用于存放所有待发布的资源文件。名称支持自定义,但必须遵循 包名规范
assets/image用于存放 README 文件中引用的图片资源的静态资源目录。如果有图片资源,建议放置在此目录下;如果没有图片资源,可以省略此目录或保持为空
armory.json发布软件包的必备配置文件,用于配置待发布的软件包的详细信息,包括软件包名称、版本、描述、检索标签和包资源路径等,具体配置要求请参见 armory.json 规范。名称固定为 armory.json,不支持自定义
READEME.md软件包概述文件,用于定义软件的概念、功能、使用指导和更新日志等概述性信息。此文件可选,其注意事项如下:
  • 如果软件包包含此文件,则文件名称和格式必须为 README.mdREADME.txt。此文件不需要在 armory.json 中配置
  • 如果此文件引用了图片资源,建议将图片放置在软件包根目录下的“assets/image”中,以便后期进行资源维护和离线迁移
windows/x86-64/armory-win-x64.exe
windows/arm64/armory-win-arm64.exe
linux/x86-64/armory-linux-x64
macos/arm64/armory-macos

待发布的软件包文件集合,支持配置多个文件或文件夹。您可以选择将所有文件打包为.tar.gz.tgz格式进行发布,也可以直接发布零散的文件或文件夹


注意:若软件包需要安装到远程 SylixOS 计算机,则无论是通过压缩包还是直接发布文件,所有包文件都必须存放在 SylixOS 系统根目录下的默认内置文件夹中,如/etc/lib/user等。有关 SylixOS 内置文件夹的详细说明,请参见 ROOT 文件系统。您可以参考 SylixOS 安装包配置示例 进行配置
文档内容是否对您有所帮助?
有帮助
没帮助