文件包

软件包是 Fuchsia 系统上的安装单元。本文档介绍了构建和安装软件包的各种工作流。

工作流程如下:

如需了解详情,请参阅来自 ffx package build helpffx repository publish help 的帮助消息。

构建软件包

如需构建软件包,请执行以下操作:

  1. 创建一个 meta 目录:

    mkdir -p PACKAGE_DIR/meta
    

    PACKAGE_DIR 替换为将在其中构建软件包的暂存目录。

  2. 设置 $META_PACKAGE_FILE 环境变量:

    export META_PACKAGE_FILE=PACKAGE_DIR/meta/package
    
  3. 打开文本编辑器并创建包含以下内容的 $META_PACKAGE_FILE 文件:

    {
      "name": "<intended name of your package here>",
      "version": "0"
    }
    

    目前,版本号必须为 0

  4. 保存文件并关闭文本编辑器。

  5. 创建一个软件包 build 清单文件 ($BUILD_MANIFEST_FILE),该文件提供所有软件包内容文件的路径,并通过变量导出其路径:

    export BUILD_MANIFEST_FILE=BUILD_MANIFEST_FILE
    

    清单文件的每一行都映射到软件包中包含的一个文件,并且采用 destination=source 形式,其中:

    • destination 是指向最终软件包中文件的路径。
    • source 是指向主机上文件的路径。

    清单文件必须至少包含一行软件包 ID 文件,例如:

    meta/package=/path/to/meta/package
    

    要添加到软件包的其他文件必须以相同的方式在 build 清单文件中列出。

  6. 转到 PACKAGE_DIR 目录:

    cd PACKAGE_DIR
    
  7. 生成软件包清单文件,以便在 PACKAGE_DIR/meta.far 中创建软件包元数据归档:

    ffx package build $BUILD_MANIFEST_FILE -o PACKAGE_DIR --api-level HEAD
    

    此命令会将软件包清单文件隐式创建为 PACKAGE_DIR/package_manifest.json

    请注意,--api-level 最好用于以数字参数指定的特定 API 级别为目标。在本例中,我们使用 HEAD,即最新的开发中 API。

  8. 设置 $PACKAGE_MANIFEST_FILE 环境变量:

    export PACKAGE_MANIFEST_FILE="PACKAGE_DIR/package_manifest.json"
    

    如果软件包的内容发生更改,您需要重新运行 ffx package build $BUILD_MANIFEST_FILE 命令。

  9. 创建一个软件包归档,将软件包中的所有内容收集到一个可分发的文件中:

    ffx package archive create -o "PACKAGE_DIR/PACKAGE_NAME.far" "$PACKAGE_MANIFEST_FILE"
    

    PACKAGE_NAME 替换为软件包的预期名称。

    此命令会将软件包归档创建为 PACKAGE_NAME.far

  10. 设置 $PACKAGE_ARCHIVE 环境变量:

    export PACKAGE_ARCHIVE=PACKAGE_DIR/PACKAGE_NAME.far
    

    如果软件包的内容发生更改,您需要重新运行 ffx package buildffx package archive create 命令。

您已成功构建软件包。现在,您可以发布该软件包了。

发布软件包

如需发布软件包,请执行以下操作:

  1. 初始化用作软件包代码库的目录:

    ffx repository create REPO
    

    这会在目录 REPO 下创建一个目录结构,该目录已准备好发布软件包。

  2. 将软件包清单发布到代码库:

    ffx repository publish --package $PACKAGE_MANIFEST_FILE REPO
    

    ffx repository publish 会解析 $PACKAGE_MANIFEST_FILE,并在提供的 REPO 目录中发布软件包。

    --package 参数可以重复使用。如果使用不同的软件包清单多次运行此命令,则每个实例将发布到同一仓库。您可以使用同一命令发布相同软件包的新版本。

  3. (可选)将软件包归档发布到代码库:

    ffx repository publish --package-archive $PACKAGE_ARCHIVE REPO
    

    ffx repository publish 会解析 $PACKAGE_ARCHIVE,并在提供的 REPO 目录中发布软件包。

    --package-archive 参数可以重复使用。如果您使用不同的软件包归档多次运行此命令,则每个实例将发布到同一仓库。您可以使用同一命令发布相同软件包的新版本。

您已成功发布软件包。现在,您可以安装软件包了。

安装软件包

如需安装软件包,请执行以下操作:

  1. 启动软件包服务器并将代码库提供给目标:

    ffx repository serve --repository "REPO_NAME" --repo-path "REPO"
    

    默认情况下,此命令会在主机上启动一个代码库服务器,并监听端口 8083。这会将代码库作为更新来源引入目标。--repository "REPO_NAME" 是可选的,但非常有用。

  2. (在目标设备上)检查已配置的代码库:

    pkgctl repo -v
    

    您应该会看到一个已配置的代码库,它(以及其他配置变量)列出了其代码库网址 "repo_url": "fuchsia-pkg://<REPO_NAME>"

  3. (在目标设备上)下载软件包:

    pkgctl resolve fuchsia-pkg://REPO_NAME/PACKAGE_NAME
    

    如果系统中尚不存在该组件,pkgctl 会下载软件包,并在解析过程中将 blob 放入 blobFS 中。如果该软件包已存在,系统将会下载更新。

您已成功安装或更新软件包。现在,您就可以运行已安装的软件包中的组件了。

运行已安装的软件包中的组件

如需运行该组件,请使用 ffx component run 工具。如需帮助,请访问:ffx component run --help

对于 url 参数,请提供 fuchsia-pkg://<REPO_NAME>/<PACKAGE_NAME>#meta/<COMPONENT_NAME>.cm 格式的网址。