Compass File Lister（Compass 文件列表器）¶

Compass file lister is an automation that lists rids (resource identifiers) of resources in a given input folder into a Code repository. When run, a new pull request is opened on the output repository where it will either create the file for the first time, or override the existing one. The generated file will be stored by default at the following path: compass-lister/rids.json. Review Create a connected flow for a step-by-step guide.

Configuration options¶

You can override the base path in output repository by setting the generated_file_path in the configuration block. If you set it to transforms-python/generated, the output will be written to transforms-python/generated/rids.json.
The resulting PR can be allowed to merge automatically if merge_when_ready is set to true in the configuration block. See your output repository settings to review the conditions that allow the PR to be merged.

Configuration example¶

{
  "generated_file_path": "transforms-python/generated",
  "merge_when_ready": true
}

中文翻译¶

Compass 文件列表器¶

Compass 文件列表器(Compass file lister)是一种自动化工具，可将指定输入文件夹中资源的 RID（资源标识符）列出到代码仓库中。运行时，它会在输出仓库中创建一个新的拉取请求(Pull Request)，该请求将首次创建文件或覆盖现有文件。生成的文件默认存储在以下路径：compass-lister/rids.json。请参阅创建连接流获取分步指南。

配置选项¶

您可以通过在配置块中设置 generated_file_path 来覆盖输出仓库中的基础路径。如果将其设置为 transforms-python/generated，则输出将写入 transforms-python/generated/rids.json。
如果在配置块中将 merge_when_ready 设置为 true，则生成的拉取请求可以自动合并。请查看您的输出仓库设置，以了解允许合并拉取请求的条件。

配置示例¶

{
  "generated_file_path": "transforms-python/generated",
  "merge_when_ready": true
}