什么是自定义属性?
自定义属性是结构化元数据字段,可在 GitHub.com 中附加到仓库或组织。 它们允许你使用合规性框架、数据敏感度或项目详细信息等信息来修饰存储库或组织。
有两种类型的自定义属性:
- 存储库自定义属性:附加到单个存储库的元数据。
- 组织自定义属性:附加到企业内组织的元数据。
使用自定义属性有什么好处?
自定义属性提供改进的发现、自动化工作流、合规性跟踪、有针对性的策略强制实施和更好的报告功能,还可通过 规则集集成实现强大的治理。
存储库和组织自定义属性都可用作规则集的目标准则,允许基于元数据进行细粒度的策略实施。
- 有关存储库自定义规则,请参阅 创建组织中存储库的规则集 和 管理企业中仓库的自定义属性。
- 有关组织自定义规则,请参阅 管理企业中存储库的代码规则集。
如何添加和管理自定义属性?
可通过多种方式管理自定义属性。 若要管理其中 GitHub的属性,可以使用:
- 您的组织或企业的设置。 请参阅“管理组织中存储库的自定义属性”和“管理组织的自定义属性”。
- GitHub 的 自定义属性的 REST API 终结点。
还可以设置集成,以便使用外部系统中的元数据(如软件目录或内部开发人员门户)自动更新自定义属性。 外部属性可以在与标准存储库自定义属性相同的位置使用。 请参阅“将自定义属性与外部系统集成”
可以使用 REST API GitHub Apps大规模管理标准自定义属性和外部属性。 当外部系统应该是事实来源时,外部属性更合适,因为它们是:
- 采用命名空间(
external_system.property_name),因此其来源清晰,并且不会与组织内的其他自定义属性发生冲突。 - 在 GitHub 上为只读,因此用户无法编辑,从而避免与外部系统不一致。
外部属性不可用于组织自定义属性(与组织关联的元数据)。