预接收挂钩

预接收挂钩 API 允许您创建、列出、更新和删除预接收挂钩。

它只适用于经过身份验证的站点管理员。普通用户尝试访问它时会收到 404 响应。

对象属性

预接收挂钩

名称	类型	描述
`name`	`字符串`	挂钩的名称。
`script`	`字符串`	挂钩运行的脚本。
`script_repository`	`对象`	保存脚本的 GitHub 仓库。
`environment`	`对象`	执行脚本的预接收环境。
`enforcement`	`字符串`	此挂钩的实施状态。
`allow_downstream_configuration`	`布尔值`	是否可以在组织或仓库级别上覆盖实施。

enforcement 的可能值包括 enabled、disabled 和 testing。 disabled 表示预接收挂钩不会运行。 enabled 表示它将运行并拒绝会导致非零状态的任何推送。 testing 表示脚本将运行，但不会导致任何推送被拒绝。

List pre-receive hooks

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github+json` is recommended.
查询参数
名称, 类型, 描述
`per_page`integer The number of results per page (max 100). 默认值: `30`
`page`integer Page number of the results to fetch. 默认值: `1`
`direction`string The direction to sort the results by. 默认值: `desc` 可以是以下其中之一: `asc`, `desc`
`sort`string The property to sort the results by. 默认值: `created` 可以是以下其中之一: `created`, `updated`, `name`

HTTP 响应状态代码

状态代码	描述
`200`	OK

代码示例

get/admin/pre-receive-hooks

curl \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks

Response

Status: 200

[
  {
    "id": 1,
    "name": "Check Commits",
    "enforcement": "disabled",
    "script": "scripts/commmit_check.sh",
    "script_repository": {
      "id": 595,
      "full_name": "DevIT/hooks",
      "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
      "html_url": "https://github.example.com/DevIT/hooks"
    },
    "environment": {
      "id": 2,
      "name": "DevTools Hook Env",
      "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
      "html_url": "https://github.example.com/admin/pre-receive-environments/2",
      "default_environment": false,
      "created_at": "2016-05-20T11:35:45-05:00",
      "hooks_count": 1,
      "download": {
        "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
        "state": "success",
        "downloaded_at": "2016-05-26T07:42:53-05:00",
        "message": null
      }
    },
    "allow_downstream_configuration": false
  }
]

Create a pre-receive hook

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github+json` is recommended.
正文参数
名称, 类型, 描述
`name`string必选 The name of the hook.
`script`string必选 The script that the hook runs.
`script_repository`object必选 The GitHub repository where the script is kept.
`environment`object必选 The pre-receive environment where the script is executed.
`enforcement`string The state of enforcement for this hook. default: `disabled`
`allow_downstream_configuration`boolean Whether enforcement can be overridden at the org or repo level. default: `false`

HTTP 响应状态代码

状态代码	描述
`201`	Created

代码示例

post/admin/pre-receive-hooks

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks \
  -d '{"name":"Check Commits","script":"scripts/commit_check.sh","enforcement":"disabled","allow_downstream_configuration":false,"script_repository":{"full_name":"DevIT/hooks"},"environment":{"id":2}}'

Response

Status: 201

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 2,
    "name": "DevTools Hook Env",
    "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
    "html_url": "https://github.example.com/admin/pre-receive-environments/2",
    "default_environment": false,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": false
}

Get a pre-receive hook

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 描述
`pre_receive_hook_id`integer必选 The unique identifier of the pre-receive hook.

HTTP 响应状态代码

状态代码	描述
`200`	OK

代码示例

get/admin/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Response

Status: 200

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 2,
    "name": "DevTools Hook Env",
    "image_url": "https://my_file_server/path/to/devtools_env.tar.gz",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2",
    "html_url": "https://github.example.com/admin/pre-receive-environments/2",
    "default_environment": false,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/2/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": false
}

Update a pre-receive hook

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 描述
`pre_receive_hook_id`integer必选 The unique identifier of the pre-receive hook.
正文参数
名称, 类型, 描述
`name`string The name of the hook.
`script`string The script that the hook runs.
`script_repository`object The GitHub repository where the script is kept.
`environment`object The pre-receive environment where the script is executed.
`enforcement`string The state of enforcement for this hook.
`allow_downstream_configuration`boolean Whether enforcement can be overridden at the org or repo level.

HTTP 响应状态代码

状态代码	描述
`200`	OK

代码示例

patch/admin/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID \
  -d '{"name":"Check Commits","environment":{"id":1},"allow_downstream_configuration":true}'

Response

Status: 200

{
  "id": 1,
  "name": "Check Commits",
  "enforcement": "disabled",
  "script": "scripts/commmit_check.sh",
  "script_repository": {
    "id": 595,
    "full_name": "DevIT/hooks",
    "url": "https://github.example.com/api/v3/repos/DevIT/hooks",
    "html_url": "https://github.example.com/DevIT/hooks"
  },
  "environment": {
    "id": 1,
    "name": "Default",
    "image_url": "githubenterprise://internal",
    "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1",
    "html_url": "https://github.example.com/admin/pre-receive-environments/1",
    "default_environment": true,
    "created_at": "2016-05-20T11:35:45-05:00",
    "hooks_count": 1,
    "download": {
      "url": "https://github.example.com/api/v3/admin/pre-receive-environments/1/downloads/latest",
      "state": "success",
      "downloaded_at": "2016-05-26T07:42:53-05:00",
      "message": null
    }
  },
  "allow_downstream_configuration": true
}

Delete a pre-receive hook

参数

标头
名称, 类型, 描述
`accept`string Setting to `application/vnd.github+json` is recommended.
路径参数
名称, 类型, 描述
`pre_receive_hook_id`integer必选 The unique identifier of the pre-receive hook.

HTTP 响应状态代码

状态代码	描述
`204`	No Content

代码示例

delete/admin/pre-receive-hooks/{pre_receive_hook_id}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/admin/pre-receive-hooks/PRE_RECEIVE_HOOK_ID

Response

Status: 204