Jiri清单

英文原文快照

Jiri清单文件描述了运行“jiri update”时发生同步的项目集合。

jiri读取的第一个清单文件是[root]/.jiri_manifest，为使jiri工具能够正常工作，该清单必须存在。

[root]/.jiri_manifest清单通常会用标签的方式从远程仓库中导入其他的清单文件，但它也可以包含自己的项目列表。

清单具有以下XML模式： <!—-

  1. <manifest>
  2.   <imports>
  3.     <import remote="https://vanadium.googlesource.com/manifest"
  4.             manifest="public"
  5.             name="manifest"
  6.     />
  7.     <localimport file="/path/to/local/manifest"/>
  8.     ...
  9.   </imports>
  10.   <projects>
  11.     <project name="my-project"
  12.              path="path/where/project/lives"
  13.              protocol="git"
  14.              remote="https://github.com/myorg/foo"
  15.              revision="ed42c05d8688ab23"
  16.              remotebranch="my-branch"
  17.              gerrithost="https://myorg-review.googlesource.com"
  18.              githooks="path/to/githooks-dir"
  19.     />
  20.     ...
  21.   </projects>
  22.   <hooks>
  23.     <hook name="update"
  24.           project="mojo/public"
  25.           action="update.sh"/>
  26.     ...
  27.   </hooks>
  29. </manifest>

—->

  1. <manifest>
  2.   <imports>
  3.     <import remote="https://vanadium.googlesource.com/manifest"
  4.             manifest="public"
  5.             name="manifest"
  6.     />
  7.     <localimport file="/path/to/local/manifest"/>
  8.     ...
  9.   </imports>
  10.   <projects>
  11.     <project name="my-project"
  12.              path="path/where/project/lives"
  13.              protocol="git"
  14.              remote="https://github.com/myorg/foo"
  15.              revision="ed42c05d8688ab23"
  16.              remotebranch="my-branch"
  17.              gerrithost="https://myorg-review.googlesource.com"
  18.              githooks="path/to/githooks-dir"
  19.     />
  20.     ...
  21.   </projects>
  22.   <hooks>
  23.     <hook name="update"
  24.           project="mojo/public"
  25.           action="update.sh"/>
  26.     ...
  27.   </hooks>
  29. </manifest>

<import>和<localimport>标签可用于跨清单共享公共的项目。

当被导入的清单和执行导入清单都在同一个代码库中，或者两者都不在代码库中时，应该使用<localimport>标签。 “file”属性是被导入的清单文件的路径，它可以是绝对路径，或相对于执行导入的清单文件的路径。

如果某个清单被依赖导入，并且它位于不同的仓库中，那么必须使用<import>标签，并包含如下的属性： <!—-

  • remote (required) - The remote url of the repository containing the manifest to be imported

  • manifest (required) - The path of the manifest file to be imported, relative to the repository root.

  • name (optional) - The name of the project corresponding to the manifest repository. If your manifest contains a <project> with the same remote as the manifest remote, then the “name” attribute of on the <import> tag should match the “name” attribute on the <project>. Otherwise, jiri will clone the manifest repository on every update. —->

  • remote （必需） - 包含要导入的清单的代码仓库的远程URL

  • manifest （必需） - 要导入的清单文件相对于代码仓库根目录的路径。

  • name （可选） - 与清单仓库相对应的项目名称。 如果你的清单包含一个具有与清单相同的远程地址的<project>标签，那么<import>标签的“name”属性需与<project>上的“name”属性匹配。 否则，jiri将在每次更新时clone清单仓库。

<project>标签描述了需要同步的项目以及根据以下属性，它们应该同步到的状态：

  • name （必需） - 项目名。

  • path （必需） - 相对于jiri root，项目在本地文件系统上的路径。

  • remote （必需） - 项目代码仓库的远程url地址。

  • protocol （可选） - clone和同步代码仓库时使用的协议，目前“git”是默认和唯一支持的协议。

  • remotebranch （可选） - 项目将要被同步到的远程分支名，默认为“master”分支。 如果指定了“revision”，则“remotebranch”属性将被忽略。

  • revision （可选） - 项目将要被同步到的特定版本号（通常是git中的SHA值）。如果指定了“revision”，那么“remotebranch”属性将被忽略。

  • gerrithost （可选） - 该项目的Gerrit托管服务URL。在指定URL后，运行“jiri cl upload”将会上传一个CL到该Gerrit服务上。

  • githooks （可选） - 包含git hooks的目录的路径（相对于[root]），它将在每次更新时安装到项目的.git/hooks目录中。

<hook>标签描述了每个“jiri update”之后需执行的hook，它通过以下的属性进行配置：

  • name （必需） - 标识hook的名称

  • project （必需） - hook所处的项目名称

  • action （必需） - hook在项目内部所执行操作，通常以脚本的形式存在。