rtcamp/action-slack-notify

Slack Notify - GitHub Action

概述

Slack Notify是rtCamp的https://github.com/rtCamp/github-actions-library/%E7%9A%84%E4%B8%80%E9%83%A8%E5%88%86%EF%BC%8C%E6%98%AF%E4%B8%80%E4%B8%AA%E7%94%A8%E4%BA%8E%E5%90%91Slack%E9%A2%91%E9%81%93%E5%8F%91%E9%80%81%E9%80%9A%E7%9F%A5%E6%B6%88%E6%81%AF%E7%9A%84GitHub Action。它能够在GitHub工作流执行过程中，将事件信息（如代码推送、部署结果等）以结构化消息形式发送到指定Slack频道，支持丰富的自定义配置。

核心功能和特性

• 支持自定义Slack消息内容、标题、颜色、发送用户名称及图标
• 可通过环境变量灵活配置消息样式和内容
• 集成GitHub工作流状态，支持根据作业状态自动设置消息颜色
• 可选支持Hashicorp Vault存储Slack Webhook，增强安全性
• 可与其他GitHub Action（如Deploy WordPress）集成，显示额外上下文信息（如站点和SSH主机详情）
• 支持精简模式，可移除消息中的特定字段（如Ref、Event等）

使用场景和适用范围

• CI/CD流程通知：代码构建、测试、部署结果通知
• 代码仓库事件通知：代码推送、Pull Request创建/合并、Issue状态变更等
• 自动化任务状态通知：定时任务执行结果、监控告警等
• 团队协作沟通：将关键工作流事件实时同步到Slack频道，提高团队协作效率

使用方法

基本配置步骤

1. 在GitHub仓库中创建.github/workflows/slack-notify.yml文件
2. 添加以下工作流配置代码：

yml
on: push
name: Slack Notification Demo
jobs:
  slackNotification:
    name: Slack Notification
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Slack Notification
      uses: rtCamp/action-slack-notify@v2
      env:
        SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

3. 创建SLACK_WEBHOOK密钥：
   • 通过Slack Incoming Webhooks生成Webhook URL
   • 在GitHub仓库中添加加密密钥（路径：Settings > Secrets > New repository secret）

完整配置示例

包含所有可选环境变量的配置示例：

yml
- name: Slack Notification
  uses: rtCamp/action-slack-notify@v2
  env:
    SLACK_CHANNEL: general
    SLACK_COLOR: ${{ job.status }} # 自动根据作业状态着色或指定具体颜色（如'good'或'#ff00ff'）
    SLACK_ICON: https://github.com/rtCamp.png?size=48
    SLACK_MESSAGE: '部署成功 :rocket:'
    SLACK_TITLE: 应用部署通知
    SLACK_USERNAME: 部署机器人
    SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
    SLACK_LINK_NAMES: true
    MSG_MINIMAL: ref,event

环境变量

Hashicorp Vault（可选）

该Action支持通过Hashicorp Vault存储Slack Webhook，增强密钥管理安全性。

配置步骤

1. 在GitHub仓库中添加以下加密密钥：

2. 修改工作流配置，使用Vault相关环境变量：

yml
on: push
name: Slack Notification Demo
jobs:
  slackNotification:
    name: Slack Notification
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - name: Slack Notification
      uses: rtCamp/action-slack-notify@v2
      env:
        VAULT_ADDR: ${{ secrets.VAULT_ADDR }}
        VAULT_TOKEN: ${{ secrets.VAULT_TOKEN }}

3. 在Vault中配置Slack Webhook：
   • 在路径secret/slack下创建webhook字段，值为Slack Incoming Webhook URL

许可证

MIT © 2019 rtCamp