relaysh/github-trigger-event-sink

github-trigger-event-sink

镜像概述和主要用途

github-trigger-event-sink是一个几乎透明的GitHub事件动作传递工具，其主要目的是为GitHub Actions提供兼容性层，通过使webhook的payload能够在Relay步骤的文件系统上使用。

核心功能和特性

• 透明传递：几乎透明地传递来自GitHub的事件动作
• 兼容性支持：为GitHub Actions提供兼容性层
• Payload包装：webhook payload会被包装在名为event_payload的额外映射中，需在步骤级别解包后使用

使用场景和适用范围

适用于需要在Relay工作流中处理GitHub webhook事件的场景，特别是需要与GitHub Actions兼容，将webhook payload数据集成到Relay步骤文件系统中的工作流。

详细使用方法和配置说明

配置步骤

1. 导航到仓库设置页面：点击仓库栏上的设置。
2. 点击Webhooks。
3. 点击添加webhook。
4. 在Payload URL框中粘贴webhook URL。
5. 将Content type更改为application/json。
6. 点击让我选择单个事件。
7. 勾选想要触发的事件。
8. 点击页面底部的添加webhook。

示例用法

yaml
parameters:
  github_event:
    description: "传入的GitHub事件类型"
  event_payload:
    description: "传入的GitHub事件的完整JSON payload"
triggers:
  - name: github-event
    source:
      type: webhook
      image: docker.xuanyuan.run/relaysh/github-trigger-event-sink
    binding:
      parameters:
        github_event: ${event.github_event}
        event_payload: ${event.event_payload}
steps:
  - name: dump-payload
    image: docker.xuanyuan.run/relaysh/core
    spec:
      event_payload: ${parameters.event_payload}
    input:
      - mkdir -p /github/workflow
      - "ni get | jq .event_payload > /github/workflow/event.json"
      - cat /github/workflow/event.json

参数说明

• github_event: 传入的GitHub事件类型
• event_payload: 传入的GitHub事件的完整JSON payload，需通过jq .event_payload解包后使用