github-action-slack-notify-build 的安装和配置教程

项目基础介绍

github-action-slack-notify-build 是一个开源项目，它可以将 GitHub Actions 的构建状态通知到 Slack。这样，当你的代码在 GitHub 上触发构建时，你可以在 Slack 中实时收到通知，包括构建的开始、成功或失败状态。

该项目主要使用的编程语言是 JavaScript。

项目使用的关键技术和框架

• GitHub Actions: GitHub 提供的持续集成和持续部署（CI/CD）服务。
• Slack: 一个团队沟通工具，允许用户通过不同的通道进行交流。
• Node.js: 用于运行 JavaScript 代码的服务器端环境。

准备工作

在开始安装和配置之前，请确保你已经具备以下条件：

1. 一个 GitHub 帐户。
2. 一个 Slack 工作空间。
3. 对 GitHub Actions 和 Slack 有基本的了解。

安装步骤

步骤 1: 创建 Slack App

1. 访问 Slack 开发者网站，点击 "Create an app"。
2. 命名你的应用（例如 "GitHub Action Notify"），并确保选择了正确的 Slack 工作空间。
3. 在侧边栏中，浏览到 "Bot users" 页面，为你的应用添加一个 Bot 用户。
4. 在 "Basic information" 页面中，为你的 Bot 设置一个图标。
5. 在 "Install your app to your workspace" 部分，点击按钮完成应用的安装。

步骤 2: 配置 Slack App 的 OAuth 权限

1. 在 Slack App 的设置页面中，转到 "OAuth & Permissions" 部分。
2. 启用以下 OAuth 范围：
   • chat:write（必须）
   • channels:read（如果使用 channel 而不是 channel_id）
   • groups:read（如果使用 channel 而不是 channel_id）

步骤 3: 获取 Slack Bot Token

1. 在 "OAuth & Permissions" 部分，向下滚动到 "Bot Token" 部分。
2. 点击 "Add a New Token"，复制生成的 Bot Token。

步骤 4: 创建 GitHub 仓库 Secrets

1. 在你的 GitHub 仓库中，转到 "Settings" > "Secrets"。
2. 添加一个新的 Secret，命名为 SLACK_NOTIFICATIONS_BOT_TOKEN，值为你的 Slack Bot Token。

步骤 5: 添加 GitHub Actions 工作流

1. 在你的 GitHub 仓库中，创建一个新的 .github/workflows 文件夹（如果尚不存在）。
2. 在 .github/workflows 文件夹中，创建一个新的 YAML 文件（例如 slack-notify.yml）。
3. 在 YAML 文件中，定义你的工作流程，如下所示：

name: Slack Notify Build

on: [push]

jobs:
  notify_slack:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout code
        uses: actions/checkout@v2

      - name: Notify slack start
        uses: voxmedia/github-action-slack-notify-build@v1
        with:
          channel: '#app-alerts'
          status: 'STARTED'
          color: 'good'
          env:
            SLACK_BOT_TOKEN: '${{ secrets.SLACK_NOTIFICATIONS_BOT_TOKEN }}'

      - name: Run tests
        # 在这里添加你的测试步骤

      - name: Notify slack success
        if: success()
        uses: voxmedia/github-action-slack-notify-build@v1
        with:
          channel: '#app-alerts'
          status: 'SUCCESS'
          color: 'good'
          env:
            SLACK_BOT_TOKEN: '${{ secrets.SLACK_NOTIFICATIONS_BOT_TOKEN }}'

      - name: Notify slack fail
        if: failure()
        uses: voxmedia/github-action-slack-notify-build@v1
        with:
          channel: '#app-alerts'
          status: 'FAILED'
          color: 'danger'
          env:
            SLACK_BOT_TOKEN: '${{ secrets.SLACK_NOTIFICATIONS_BOT_TOKEN }}'

4. 保存并推送这个 YAML 文件到你的 GitHub 仓库。

现在，每当你推送代码到仓库时，GitHub Actions 将会执行定义的工作流，并在 Slack 中通知构建状态。