与外部服务集成
将 GitHub Actions 工作流连接到第三方监控、日志记录和事件管理工具
与外部服务集成 是 CoddyKit 上的免费 DevOps Bootcamp 课时。 这是第 2 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 DevOps Bootcamp 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 DevOps Bootcamp 课程共包含 4 节课。
连接您的流水线
欢迎学习将 GitHub Actions 与外部服务集成!现代软件开发依赖许多工具协同工作。
将持续集成/持续交付流水线连接到这些工具,有助于自动化通信、集中管理数据并提高团队的整体效率。
- 通知:在 Slack 或 Teams 中接收提醒。
- 问题跟踪:自动创建 JIRA 工单。
- 监控:将数据发送到 Datadog 或 Splunk。
网络钩子:基础连接
许多外部服务使用网络钩子作为接收信息的主要方式。您可以将网络钩子理解为:当特定事件发生时,从一个应用程序自动发送到另一个应用程序的消息。
当您的 GitHub Actions 工作流完成、失败或执行特定步骤时,它可以向外部服务提供的网络钩子网址发送包含数据的 POST 请求。这会触发该服务中的某项操作。
Slack:实时提醒
实时接收工作流状态通知至关重要。Slack 是一种非常常用的工具。
要从 GitHub Actions 向 Slack 发送消息,通常需要一个Slack 入站网络钩子网址。您可以在 Slack 工作区设置中生成此网址(例如,在“应用与集成”下)。
重要提示:请始终将此敏感网址存储为 GitHub 密钥,绝不要将其硬编码!
用于 Slack 提醒的工作流
下面介绍如何在工作流中使用简单的 curl 命令发送基本的 Slack 通知。此命令使用存储在名为 SLACK_WEBHOOK_URL 的密钥中的网络钩子网址。
此示例会在每次向 main 推送时通知您。
name: Slack Notification Demo
on:
push:
branches:
- main
jobs:
notify:
runs-on: ubuntu-latest
steps:
- name: Send Slack Notification
run: |
curl -X POST -H 'Content-type: application/json' \
--data '{"text":"GitHub Actions workflow *${{ github.workflow }}* for commit `{{ github.sha }}` by _${{ github.actor }}_ on branch `${{ github.ref_name }}` has completed!"}' \
${{ secrets.SLACK_WEBHOOK_URL }}使用市场操作简化集成
虽然 curl 可以完成任务,但使用预构建的 GitHub Marketplace Actions 可以简化许多集成。这些操作封装了与特定服务交互所需的逻辑,让您的工作流更加简洁易读。
您可以在 GitHub Marketplace 中搜索能够连接到所需服务的操作。例如,那里有许多用于 Slack、JIRA、Microsoft Teams 等服务的操作。
JIRA:自动化问题跟踪
与 JIRA 等问题跟踪系统集成后,可以自动执行以下任务:
- 在工作流失败时创建新的缺陷工单。
- 根据拉取请求事件向现有问题添加评论。
- 随着代码在流水线中推进而更新问题状态。
这样可以在无需人工干预的情况下,让开发团队和运维团队保持协同。
用于 JIRA 问题的工作流
此示例使用常用的市场操作:如果特定工作流(例如持续集成工作流)失败,就创建一个 JIRA 问题。请注意,它使用 GitHub 密钥进行身份验证。
workflow_run 触发器允许此工作流响应另一个工作流的完成。
name: JIRA Issue on Failed Workflow
on:
workflow_run:
workflows: ["Your CI Workflow Name Here"]
types:
- completed
jobs:
create_issue:
if: ${{ github.event.workflow_run.conclusion == 'failure' }}
runs-on: ubuntu-latest
steps:
- name: Create JIRA Bug Ticket
uses: atlassian/github-jira-action@v2.1.0
with:
jira-base-url: ${{ secrets.JIRA_BASE_URL }}
jira-user-email: ${{ secrets.JIRA_USER_EMAIL }}
jira-api-token: ${{ secrets.JIRA_API_TOKEN }}
project: 'DEV'
issue-type: 'Bug'
summary: 'Workflow failed: ${{ github.event.workflow_run.workflow_name }}'
description: 'Workflow run URL: ${{ github.event.workflow_run.html_url }}\nFailed commit: ${{ github.event.workflow_run.head_sha }}'连接监控与日志
除了通知和问题跟踪之外,您还可以与 Datadog、Splunk、New Relic 或自定义日志聚合工具等高级监控和日志记录工具集成。
- 指标:发送有关构建时间或测试结果的自定义指标。
- 日志:转发工作流日志,以便集中分析。
- 链路追踪:将部署事件与应用程序性能关联起来。
这些集成通常需要使用特定的应用程序接口,或使用工具供应商提供的专用 Marketplace Actions。
保护您的集成
与外部服务集成时,安全性至关重要。您经常需要处理应用程序接口密钥、令牌和网络钩子网址,而这些信息可以授予对外部账户的访问权限。
请始终使用 GitHub 密钥存储这些敏感凭据。绝不要将它们直接硬编码到工作流文件中。这样可以防止意外泄露并确保凭据安全。
快速检查:集成安全性
您需要使用应用程序接口密钥将 GitHub Actions 工作流连接到外部事件管理系统。在工作流中处理此应用程序接口密钥时,哪种方法最安全且最值得推荐?
回顾:集成式工作流
您已经学会了如何将 GitHub Actions 工作流与各种外部服务集成!
- 网络钩子是实现这些连接的常见机制。
- Slack 和 JIRA 是通知和问题跟踪方面的常见示例。
- GitHub Marketplace Actions 可以简化复杂的集成。
- 请始终使用 GitHub 密钥安全地管理应用程序接口密钥和网络钩子网址等敏感凭据。
这些集成让您的持续集成/持续交付流水线更加强大,并能更好地连接到团队更广泛的生态系统。
常见问题解答
「与外部服务集成」课时是免费的吗?
是的 — 「与外部服务集成」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 DevOps Bootcamp 课程的其余内容,请升级到 CoddyKit PRO。 DevOps Bootcamp 课程共包含 4 节课。
「与外部服务集成」这节课中我会学到什么?
将 GitHub Actions 工作流连接到第三方监控、日志记录和事件管理工具 你通过在浏览器中直接运行的动手代码来练习 DevOps Bootcamp,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 DevOps Bootcamp 需要有经验吗?
无需任何先前经验。CoddyKit 上的 DevOps Bootcamp 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 2 节课,共 4 节。
「与外部服务集成」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 DevOps Bootcamp 课中编写并运行代码吗?
能。每节 DevOps Bootcamp 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 流水线监控策略
- 与外部服务集成
- 设置通知与告警
- 结构化日志与分布式追踪