Skip to main content

管理组织中存储库的自定义属性

借助自定义属性,可将元数据添加到组织中的存储库。 可以使用这些属性将包含规则集的存储库作为目标。

谁可以使用此功能?

Organization owners and users with the "Manage the organization's custom properties definitions" permission can add and set a custom property schema at the organization level.

关于自定义属性

使用自定义属性可以利用合规性框架、数据敏感度或项目详细信息等信息修饰存储库。 自定义属性属于私有属性,只有对存储库具有读取权限的人员才能查看。

可以根据存储库属性确定将哪些包含规则集的存储库作为目标。 有关详细信息,请参阅“创建组织中存储库的规则集”。

允许的字符

自定义属性名称和值只能包含特定的字符:

  • 名称:a-zA-Z0-9_-$#
  • 值:所有可打印的 ASCII 字符," 除外。

添加自定义属性

可以将自定义属性添加到组织,并为组织中的存储库设置属性值。

你也可以使用 REST API 为组织创建和管理自定义属性。 有关详细信息,请参阅“自定义属性的 REST API 终结点”。

  1. 在 GitHub 的右上角,选择个人资料照片,然后单击 你的组织”。

  2. 在组织旁边,单击“设置”。

  3. 在左侧边栏的“代码、规划和自动化”部分,单击“ 存储库”,然后单击“自定义属性”

    组织的设置页面的屏幕截图。 在边栏中,标有“自定义属性”的链接以橙色标出。

  4. 要添加新的自定义属性,请单击右上角的“新建属性”****。

  5. 在“名称”字段中键入要用于自定义属性的名称。 名称不能包含空格。

  6. (可选)在“描述”字段中填写自定义属性的描述。

  7. 在“类型”下,选择要添加的属性类型。 这可以是文本字符串、单选字段、多选字段或 true/false 布尔值。

  8. (可选)可以选择“允许存储库执行者设置此属性”****。 启用后,具有存储库级别“自定义属性”细化权限的存储库用户和应用将能够为其存储库设置和更新属性值。

  9. (可选)可以选择“所有存储库均需具有此属性”****,并添加默认值。 这意味着组织中的所有存储库此属性均需具有值。 若存储库此属性没有显式值,则继承默认值。

  10. 单击“保存属性”****。

为组织中的存储库设置值

你以及任何具有“在组织级别编辑自定义属性值”权限的用户可以为组织中的存储库设置自定义属性的值。

  1. 在 GitHub 的右上角,选择个人资料照片,然后单击 你的组织”。

  2. 在组织旁边,单击“设置”。

  3. 在左侧边栏的“代码、规划和自动化”部分,单击“ 存储库”,然后单击“自定义属性”

    组织的设置页面的屏幕截图。 在边栏中,标有“自定义属性”的链接以橙色标出。

  4. 单击“设置值”选项卡。

  5. 从列表中选择一个或多个存储库,然后单击 “编辑属性”****。

    存储库设置值的页面屏幕截图。 标有铅笔图标和“编辑属性”的按钮以橙色边框突出显示。

  6. 在出现的模式对话框中选择要为选定存储库设置的属性值。

  7. 单击“保存更改”。

查看组织中存储库的值

对存储库具有读取权限的人员可以查看存储库自定义属性的值但无法对其进行编辑。

你也可以使用 REST API 列出组织分配给存储库的自定义属性。 有关详细信息,请参阅“自定义属性的 REST API 终结点”。

  1. 在 GitHub 上,导航到存储库的主页面。

  2. 在存储库名称下,单击 “设置”。 如果看不到“设置”选项卡,请选择“”下拉菜单,然后单击“设置”。

    存储库标头的屏幕截图,其中显示了选项卡。 “设置”选项卡以深橙色边框突出显示。

  3. 在边栏的“代码和自动化”部分,单击“ 自定义属性”****。

按自定义属性值搜索和筛选存储库

可以按自定义属性值搜索组织中的存储库。

  1. 在 GitHub 的右上角,选择个人资料照片,然后单击 你的组织”。
  2. 单击您的组织名称。
  3. 在组织名称下,单击 “存储库”****。
  4. 在搜索栏中键入 prop 查看组织自定义属性的完整列表,然后选择要作为搜索条件的属性。