文档首页/ 代码托管 CodeArts Repo/ API参考/ API/ V4/ Repository/ 修改仓库通用提交规则
更新时间：2025-09-28 GMT+08:00
查看PDF
分享

修改仓库通用提交规则

功能介绍

修改仓库通用提交规则

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

PUT /v4/repositories/{repository_id}/general-commit-rule

表1 路径参数

参数

是否必选

参数类型

描述

repository_id

是

Integer

参数解释：

仓库的ID，通过查询用户所有仓库接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

1-2147483647

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

必传。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

reject_unsigned_commits

否

Boolean

参数解释：

是否拒绝未Signed-off-by签名的提交。

约束限制：

不涉及。

取值范围：

  • true，拒绝未Signed-off-by签名的提交。

  • false，允许未Signed-off-by签名的提交。

默认取值：

不涉及。

reject_not_signed_by_gpg

否

Boolean

参数解释：

是否拒绝未GPG签名的提交。

约束限制：

不涉及。

取值范围：

  • true，拒绝未GPG签名的提交。

  • false，允许未GPG签名的提交。

默认取值：

不涉及。

deny_delete_tag

否

Boolean

参数解释：

是否不允许删除Tags。

约束限制：

不涉及。

取值范围：

  • true，不允许删除Tags。

  • false，允许删除Tags。

默认取值：

不涉及。

prevent_secrets

否

Boolean

参数解释：

是否阻止包含涉密文件的提交。

约束限制：

不涉及。

取值范围：

  • true，阻止包含涉密文件的提交。

  • false，允许包含涉密文件的提交。

默认取值：

不涉及。

deny_force_push

否

Boolean

参数解释：

是否禁止强制推送。

约束限制：

不涉及。

取值范围：

  • true，禁止强制推送。

  • false，允许强制推送。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

reject_unsigned_commits

Boolean

参数解释：

是否拒绝未Signed-off-by签名的提交。

约束限制：

不涉及。

取值范围：

  • true，拒绝未Signed-off-by签名的提交。

  • false，允许未Signed-off-by签名的提交。

默认取值：

不涉及。

reject_not_signed_by_gpg

Boolean

参数解释：

是否拒绝未GPG签名的提交。

约束限制：

不涉及。

取值范围：

  • true，拒绝未GPG签名的提交。

  • false，允许未GPG签名的提交。

默认取值：

不涉及。

deny_delete_tag

Boolean

参数解释：

是否不允许删除Tags。

约束限制：

不涉及。

取值范围：

  • true，不允许删除Tags。

  • false，允许删除Tags。

默认取值：

不涉及。

prevent_secrets

Boolean

参数解释：

是否阻止包含涉密文件的提交。

约束限制：

不涉及。

取值范围：

  • true，阻止包含涉密文件的提交。

  • false，允许包含涉密文件的提交。

默认取值：

不涉及。

deny_force_push

Boolean

参数解释：

是否禁止强制推送。

约束限制：

不涉及。

取值范围：

  • true，禁止强制推送。

  • false，允许强制推送。

默认取值：

不涉及。

请求示例

修改仓库通用提交规则

PUT /v4/repositories/{repository_id}/general-commit-rule

{
  "reject_unsigned_commits" : true,
  "reject_not_signed_by_gpg" : true,
  "deny_delete_tag" : true,
  "prevent_secrets" : true,
  "deny_force_push" : true
}

响应示例

状态码：200

仓库通用提交规则

{
  "reject_unsigned_commits" : true,
  "reject_not_signed_by_gpg" : true,
  "deny_delete_tag" : true,
  "prevent_secrets" : true,
  "deny_force_push" : true
}

状态码

状态码

描述

200

仓库通用提交规则

错误码

请参见错误码。

父主题： Repository

相关文档