comicrelief/concourse-contentful-webhook

concourse-contentful-webhooks 镜像文档

镜像概述

concourse-contentful-webhooks是一个Concourse CI资源类型Docker镜像，专门用于在Concourse CI管道中集成Contentful内容管理平台的webhook功能。通过该镜像，用户可以配置基于Contentful内容变更事件触发Concourse管道执行，实现内容更新与CI/CD流程的自动化集成。

核心功能与特性

• Contentful事件集成：支持接收并处理Contentful平台的内容变更事件
• 灵活的环境配置：可指定Contentful环境（master/staging），默认使用master环境
• 安全认证：通过Contentful访问令牌进行API认证，确保安全访问
• Concourse webhook兼容：符合Concourse CI资源类型规范，支持webhook_token配置实现安全触发

使用场景

• 当Contentful中的内容（如文章、页面、媒体资源）发生创建、更新或删除时，自动触发Concourse管道执行
• 内容发布后自动触发网站构建和部署流程
• 内容变更时自动执行测试、预览或同步操作

使用方法与配置说明

资源类型配置

在Concourse管道配置文件（pipeline.yml）中，首先需要定义资源类型：

yaml
resource_types:
  - name: concourse-contentful-webhooks
    type: docker-image
    source:
      repository: bigorangemachine/concourse-contentful-webhooks

资源配置

配置具体的Contentful webhook资源，包含webhook令牌和源配置：

yaml
resources:
  - name: contentful-hook
    type: concourse-contentful-webhooks
    webhook_token: <YOUR-WEBHOOK-TOKEN>  # 用于验证webhook请求的安全令牌
    source:
      space-id: <CONTENTFUL-SPACE-ID>      # Contentful空间唯一ID
      access-token: <CONTENTFUL-ACCESS-TOKEN>  # Contentful API访问令牌
      environment: master  # 可选，Contentful环境，默认为master，可设置为staging

源配置参数说明

完整配置示例

yaml
resource_types:
  - name: concourse-contentful-webhooks
    type: docker-image
    source:
      repository: bigorangemachine/concourse-contentful-webhooks

resources:
  - name: contentful-hook
    type: concourse-contentful-webhooks
    webhook_token: secretabc123  # 替换为实际的安全令牌
    source:
      space-id: zxx111222333  # 替换为实际的Contentful空间ID
      access-token: 1010ffeebbccddee00112233445566778899aabbccddeeff0011223344556677  # 替换为实际的访问令牌
      environment: master  # 可选，根据需要设置为master或staging

Webhook URL配置

在Contentful平台中配置webhook时，需使用以下URL格式： http://<CONCOURSE-URL>/api/v1/teams/main/pipelines/[PIPELINE-NAME]/resources/[RESOURCE-NAME]/check/webhook?webhook_token=[WEBHOOK-TOKEN]

其中：

• <CONCOURSE-URL>：Concourse CI实例的URL
• [PIPELINE-NAME]：管道名称
• [RESOURCE-NAME]：资源名称（如示例中的contentful-hook）
• [WEBHOOK-TOKEN]：资源配置中定义的webhook_token值

调试方法

容器内交互式调试

bash
# 获取镜像ID
docker image ls
# 启动交互式容器
docker run -i -t <DOCKER-IMAGE-ID> /bin/ash
# 在容器内测试输入
printf '{"only":"a-test"}'|./check

Concourse拦截调试

bash
fly -t tutorial intercept --check <PIPELINE-NAME>/<RESOURCE-NAME>

参考文档

• https://concourse-ci.org/resources.html
• Contentful API密钥管理