rafikn/flowdock-notification-resource

flowdock-notification-resource

Concourse CI资源，用于向Flowdock的工作流发送通知。

注意：本资源使用Flowdock的Messages API，并依赖flow_token进行身份验证。

前置条件：你需要为Flowdock工作流配置一个源，该源会生成flow_token，允许Concourse向该工作流发布消息。

使用方法

在Pipeline YAML文件中包含以下内容，替换括号(())中的值：

yaml
resource_types:
- name: flowdock-notification
  type: docker-image
  source:
    repository: rafikn/flowdock-notification-resource
    
resources:
- name: flowdock-notifier
  type: flowdock-notification
  source:
    author: concourse
    avatar: http://cl.ly/image/3e1h0H3H2s0P/concourse-logo.png
    flow_token: ((flow_token))
    flow_api: ((flow_api))

然后配置作业以使用该资源：

yaml
- name: job
  plan:
  - task: sample_task
    ...
    on_success:
      put: flowdock-notifier
      params:
        event: activity
        message_title: sample_task作业成功
        message_body: sample_task作业已成功完成
        status_colour: lime
        status_value: SUCCESS
    on_failure:
      put: flowdock-notifier
      params:
        event: activity
        message_title: sample_task作业失败
        message_body: sample_task作业执行失败
        status_colour: red
        status_value: FAILURE

源配置（Source Configuration）

• flow_token 必选。参考此处获取flow_token。flow_token与源关联，允许Concourse向对应工作流发布消息。
• flow_api 必选。可选值为https://api.flowdock.com/messages、https://api.flowdock.com/flows/:organization/:flow/messages或https://api.flowdock.com/flows/:organization/:flow/messages/threads/:id/messages。
• author 通知关联的用户名。
• avatar 通知关联的头像URL。
• event 可选值为activity或message。activity通知显示在工作流的收件箱中，message通知显示在主线程中。

out配置

• message_body 必选。消息文本内容。
• message_title 可选（仅activity通知）。消息标题，若提供则会追加构建编号；若未提供，默认格式为pipeline | job | build | [status]。
• status_value 必选（仅activity通知）。线程的状态标签。
• status_color 必选（仅activity通知）。状态标签的背景颜色。
• thread_id 可选。默认按作业名称线程化，或设置为job_name时按作业名称；设置为build_number时按构建编号；否则按配置的显式值线程化。

资源source中的所有配置均可在通知任务的params中覆盖。通常建议在source级别配置通用值（如flow_token、flow_api），在任务params级别配置消息属性（如event、message_body）。

贡献

请将所有拉取请求提交到master分支，并确保out脚本测试在本地通过。

许可证

MIT