We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the Actions REST API page.
存储库预接收挂钩
使用 REST API 查看和修改存储库可用的预接收挂钩的强制执行。
关于存储库预接收挂钩
名称 | 类型 | 说明 |
---|---|---|
name | string | 挂钩的名称。 |
enforcement | string | 此仓库中挂钩的实施状态。 |
configuration_url | string | 设置实施的端点 URL。 |
强制执行的可能值为 enabled
、disabled
和 testing
。 disabled
表示预接收挂钩不会运行。 enabled
表示它将运行并拒绝任何导致非零状态的推送。 testing
表示脚本将运行但不会导致任何推送被拒绝。
configuration_url
可能是此存储库、其组织所有者或全局配置的链接。 configuration_url
终结点的访问授权在所有者或站点管理员级别确定。
List pre-receive hooks for a repository
List all pre-receive hooks that are enabled or testing for this repository as well as any disabled hooks that are allowed to be enabled at the repository level. Pre-receive hooks that are disabled at a higher level and are not configurable will not be listed.
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
Query parameters |
名称, Type, 说明 |
per_page integerThe number of results per page (max 100). Default: |
page integerPage number of the results to fetch. Default: |
direction stringThe direction to sort the results by. Default: Can be one of: |
sort stringDefault: Can be one of: |
HTTP response status codes
Status code | 说明 |
---|---|
200 | OK |
Code samples
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks
Response
Status: 200
[
{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}
]
Get a pre-receive hook for a repository
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
pre_receive_hook_id integerRequiredThe unique identifier of the pre-receive hook. |
HTTP response status codes
Status code | 说明 |
---|---|
200 | OK |
Code samples
curl \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
Response
Status: 200
{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}
Update pre-receive hook enforcement for a repository
For pre-receive hooks which are allowed to be configured at the repo level, you can set enforcement
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
pre_receive_hook_id integerRequiredThe unique identifier of the pre-receive hook. |
Body parameters |
名称, Type, 说明 |
enforcement stringThe state of enforcement for the hook on this repository. Can be one of: |
HTTP response status codes
Status code | 说明 |
---|---|
200 | OK |
Code samples
curl \
-X PATCH \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
-d '{"enforcement":"enabled"}'
Response
Status: 200
{
"id": 42,
"name": "Check Commits",
"enforcement": "enabled",
"configuration_url": "https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42"
}
Remove pre-receive hook enforcement for a repository
Deletes any overridden enforcement on this repository for the specified hook.
Responds with effective values inherited from owner and/or global level.
Parameters
Headers |
---|
名称, Type, 说明 |
accept stringSetting to |
Path parameters |
名称, Type, 说明 |
owner stringRequiredThe account owner of the repository. The name is not case sensitive. |
repo stringRequiredThe name of the repository. The name is not case sensitive. |
pre_receive_hook_id integerRequiredThe unique identifier of the pre-receive hook. |
HTTP response status codes
Status code | 说明 |
---|---|
200 | Responds with effective values inherited from owner and/or global level. |
Code samples
curl \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/pre-receive-hooks/PRE_RECEIVE_HOOK_ID
Responds with effective values inherited from owner and/or global level.
Status: 200
{
"id": 42,
"name": "Check Commits",
"enforcement": "disabled",
"configuration_url": "https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42"
}