使用 GitHub Actions 自动化 DevOps 工作流程

作者：Trix Cyrus

Waymap渗透测试工具：点击这里
TrixSec Github：点击这里

---

什么是 GitHub 操作？

GitHub Actions 是集成到 GitHub 中的自动化工具，提供自动化工作流程、CI/CD 管道、测试、代码质量检查，甚至直接在存储库中部署的功能。它使您能够使用 YAML 文件定义工作流程，从而完全控制触发器、环境和任务。

---

为什么使用 GitHub Actions 进行 DevOps？

1. 与 GitHub 集成：与 GitHub 存储库、问题和拉取请求无缝集成。
2. 可扩展的 CI/CD 管道：在各种平台上运行构建、测试和部署。
3. 可定制的工作流程：定义符合您确切需求的工作流程，从简单的任务到复杂的多步骤流程。
4. 可重用工作流程：跨多个项目共享可重用工作流程和自定义操作。

---

GitHub Actions 的关键组件

1. 工作流程：存储在 .github/workflows 目录中的 YAML 文件中定义的自动化流程。
2. 作业：每个工作流程都由可以同时或顺序运行的作业组成。
3. 步骤：每个作业都有一系列步骤，其中可能包括运行命令、脚本或可重用的操作。
4. 触发器：定义触发工作流的事件，例如push、pull_request、schedule等

---

设置您的第一个 DevOps 工作流程

让我们逐步创建一个基本的 CI 工作流程，以便在推送新提交时测试和构建代码。

1. 创建工作流程文件
   
   导航到存储库中的 .github/workflows 并创建一个名为 ci.yml 的文件。

2. 定义工作流程结构
   

   name: CI Workflow

   on:
     push:
       branches:
         - main
     pull_request:
       branches:
         - main

   jobs:
     build:
       runs-on: ubuntu-latest

       steps:
         - name: Checkout code
           uses: actions/checkout@v3

         - name: Set up Node.js
           uses: actions/setup-node@v3
           with:
             node-version: '16'

         - name: Install dependencies
           run: npm install

         - name: Run tests
           run: npm test

         - name: Build project
           run: npm run build

1. 工作流程说明

• 触发器（开启）：工作流在针对主分支的 Push 或 Pull_request 事件上触发。
• 作业：我们有一个构建作业，用于安装依赖项、运行测试和构建项目。
• 步骤：每个步骤都使用操作或命令（例如，用于检查代码的 actions/checkout、用于设置 Node.js 的 actions/setup-node 以及各种 npm 命令）。

---

添加 Linting 和代码质量检查

为了确保代码质量，您可以在工作流程中添加 linting 步骤。

- name: Lint code
  run: npm run lint

在安装依赖项之后添加此步骤有助于在管道早期识别代码质量问题。

---

使用 GitHub Actions 自动化部署

现在，让我们向云服务添加自动部署步骤，例如 AWS 或 Firebase。

示例：部署到 Firebase

1. 设置 Firebase CLI
   
   首先，在本地计算机上安装并配置 Firebase CLI。使用 firebase login:ci 生成令牌并将其存储为 GitHub 机密 (FIREBASE_TOKEN)。

2. 添加部署步骤
   

   name: CI Workflow

   on:
     push:
       branches:
         - main
     pull_request:
       branches:
         - main

   jobs:
     build:
       runs-on: ubuntu-latest

       steps:
         - name: Checkout code
           uses: actions/checkout@v3

         - name: Set up Node.js
           uses: actions/setup-node@v3
           with:
             node-version: '16'

         - name: Install dependencies
           run: npm install

         - name: Run tests
           run: npm test

         - name: Build project
           run: npm run build

这里，我们指定needs: build，意味着此部署作业仅在构建作业成功完成后运行。

---

高级 GitHub 操作提示

1. 使用缓存：通过缓存依赖项来加快工作流程。

- name: Lint code
  run: npm run lint

1. 矩阵构建：使用矩阵策略跨多个版本或平台进行测试。

   deploy:
     needs: build
     runs-on: ubuntu-latest

     steps:
       - name: Checkout code
         uses: actions/checkout@v3

       - name: Set up Node.js
         uses: actions/setup-node@v3
         with:
           node-version: '16'

       - name: Install dependencies
         run: npm install

       - name: Build project
         run: npm run build

       - name: Deploy to Firebase
         env:
           FIREBASE_TOKEN: ${{ secrets.FIREBASE_TOKEN }}
         run: |
           npm install -g firebase-tools
           firebase deploy

1. Secrets 和环境变量：将敏感信息存储在 GitHub Secrets 中并使用 ${{ Secrets.SECRET_NAME }} 访问它们。

---

监控和调试工作流程

• 查看日志：GitHub Actions 中的每个步骤都会生成可通过“Actions”选项卡访问的日志。
• 调试模式：在机密中添加 ACTIONS_STEP_DEBUG，值为 true 以进行详细日志记录。
• 错误通知：设置通知（例如 Slack 或电子邮件）以接收有关工作流程失败的警报。

---

可重用的工作流程

随着项目的增长，请考虑通过在 YAML 文件中定义工作流_call 并在多个存储库中重用来创建可重用的工作流程，特别是对于代码格式化或安全扫描等任务。

---

总结

使用 GitHub Actions 自动化 DevOps 工作流程可提高工作效率、减少人为错误并创建更强大的 CI/CD 管道。通过在后台无缝运行的工作流程，开发人员可以更多地专注于编写代码，而不是部署任务。从测试开始，逐渐扩展到部署和监控，以最大限度地发挥 GitHub Actions 在 DevOps 之旅中的潜力。

---

本指南为使用 GitHub Actions 构建、测试和部署项目提供了基础。一旦熟悉了，您就可以通过自定义操作、集成和高级自动化进一步扩展，以实现完全优化的 DevOps 管道。

~TrixSec

以上是使用 GitHub Actions 自动化 DevOps 工作流程的详细内容。更多信息请关注PHP中文网其他相关文章！