homedepottech/github-webhook-resource

GitHub Webhook 资源

默认情况下，Concourse每分钟会对资源执行一次check操作以检查是否有更新。为减少过多的check操作，需配置Webhook来外部触发Concourse。本资源可自动配置GitHub仓库，在发生变更时立即向Concourse流水线发送Webhook。

资源类型配置

yaml
resource_types:
- name: github-webhook-resource
  type: docker-image
  source:
    repository: homedepottech/github-webhook-resource
    tag: latest

源配置

yaml
resources:
- name: github-webhook
  type: github-webhook-resource
  source:
    github_api: https://github.example.com/api
    github_token: ((github-token))

• github_api：必填。仓库的GitHub API URL。
• github_token：必填。https://github.com/settings/tokens/new?scopes=admin:repo_hook。此外，令牌所属账户必须https://help.github.com/en/articles/managing-an-individuals-access-to-an-organization-repository才能管理仓库的Webhook。

行为

out：操作GitHub Webhook

使用配置的参数创建或删除Webhook。

参数

yaml
- put: create-webhook
  resource: github-webhook
  params:
    org: github-org-name
    repo: github-repo-name
    resource_name: your-resource-name
    webhook_token: your-token
    operation: create
    events: [push, pull_request]

• org：必填。GitHub组织名称。
• repo：必填。GitHub仓库名称。
• resource_name：必填。要关联Webhook的资源名称。
• webhook_token：必填。用于识别Webhook的任意字符串。必须与Webhook指向的资源的webhook_token属性匹配。
• operation：必填。
  • create：创建新Webhook。如果配置与远程不同，会更新现有Webhook。
  • delete：删除现有Webhook。如果Webhook不存在，输出当前时间戳。
• events：可选。触发Webhook的https://developer.github.com/webhooks/#events数组。默认值：`push`

开发

前提条件

• https://nodejs.org/
• https://www.docker.com/

修改代码

Concourse入口点位于bin/check、bin/in和bin/out。可直接在这些文件中添加功能，或require其他支持文件。

有关本项目实现的帮助信息，请参见参考部分。

运行测试

shell
npm install
npm test

提交更改供审核前，请确保所有测试通过。

构建更改

shell
docker build -t github-webhook-resource .

要使用新构建的镜像，需将其推送到Concourse流水线可访问的Docker仓库，并配置流水线使用该镜像：

shell
docker tag github-webhook-resource example.com/github-webhook-resource
docker push example.com/github-webhook-resource

yaml
resource_types:
- name: github-webhook-resource
  type: docker-image
  source:
    repository: example.com/github-webhook-resource
    tag: latest

resources:
- name: github-webhook
  type: github-webhook-resource
  ...

贡献

请阅读CONTRIBUTING.md文件，了解向本仓库提交更改的流程。

许可证

本项目基于https://www.apache.org/licenses/LICENSE-2.0许可 - 详见LICENSE文件。

参考

• https://concourse-ci.org/implementing-resource-types.html
• https://help.github.com/articles/about-webhooks/
• https://developer.github.com/v3/repos/hooks/
• https://github.com/concourse/concourse/wiki/Resource-Types