使用自定义属性可以利用合规性框架、数据敏感度或项目详细信息等信息修饰存储库。 自定义属性属于私有属性,只有对存储库具有读取权限的人员才能查看。 企业最多可以有 100 个属性定义。 允许值列表最多可以有 200 项。
通过在企业级定义自定义属性,可以创建用户可应用于仓库的一致值。 有了自定义属性,你就可以通过创建具有特定属性的仓库为目标仓库的规则集或仓库策略,对企业中的仓库应用一致的治理。 请参阅“治理人员如何在企业中使用仓库”。
允许的字符
自定义属性名称和值只能包含特定的字符:
- 名称:
a-z
、A-Z
、0-9
、_
、-
、$
、#
。 - 值:所有可打印的 ASCII 字符,
"
除外。
谁可以设置和查看我定义的自定义属性的值?
定义自定义属性后,用户就可以在企业的仓库中设置该属性的值。 请参阅“管理组织中存储库的自定义属性”。
- 企业所有者可以为所需的属性设置默认值。
- 组织所有者可以在其组织内跨仓库或在仓库级设置值。
- 如果启用,则具有仓库访问权限或
custom properties
细化权限的人员就可以设置和更新其仓库的属性值。
对仓库具有读取权限的人员可以查看该仓库的自定义属性值。
此外,组织所有者还可以通过自定义属性值在其组织中搜索仓库。 请参阅“管理组织中存储库的自定义属性”。
添加自定义属性
可以将自定义属性添加到企业,以使这些属性在所有组织中都可用。
- 在 GitHub 的右上角,单击你的个人资料照片。
- 根据环境,单击“你的企业”,或单击“你的企业”,然后单击要查看的企业********。
- 在左侧边栏中的“Policies”下,单击“Custom properties”****。
- 若要添加新的自定义属性,请单击右上角的“New property”****。
- 输入自定义属性的名称、描述和类型。 名称在所有组织中必须是唯一的,并且不能包含空格。
- (可选)选择“Allow repository actors to set this property”****。 启用后,具有仓库级
custom properties
细化权限的仓库用户和应用将能够设置和更新其仓库的属性值。 此外,任何创建仓库的行为者都可以在仓库上设置属性。 - (可选)选择“Require this property for all repositories”,并添加默认值****。 这意味着你要求企业中的所有仓库都具有该属性的值。 若存储库此属性没有显式值,则继承默认值。
- 单击“保存属性”****。
将组织属性提升为企业属性
可以将属性从组织提升到企业帐户,以确保属性名称和值可用于企业中的所有组织。
- 在 GitHub 的右上角,单击你的个人资料照片。
- 根据环境,单击“你的企业”,或单击“你的企业”,然后单击要查看的企业********。
- 在左侧边栏中的“Policies”下,单击“Custom properties”****。
- 要查看组织管理的所有属性,请选择“Filter”,然后选择“Managed by”限定符和“organization”作为值,或在筛选栏中输入
managed-by:organization
************。 - (可选)要查看特定组织管理的属性,请选择“Filter”,然后选择“Organization”限定符和一个组织名作为值,或在筛选栏中输入
org:<ORGANIZATION-NAME>
********。 - 从属性列表中,选择要提升的属性名称。 这会转到属性详细信息页。
- 若要提升所选属性,请单击“Promote to enterprise”****。 属性名称在企业中的所有组织中必须是唯一的,否则不允许提升。
- 单击“提升”。