极速入门GitHub Action：5分钟搭建自动工作流

后端

2022-11-20 12:37:51

什么是GitHub Actions？

GitHub Actions 是 GitHub 提供的一项自动化服务，可以用于执行持续集成（CI）、持续交付（CD）等任务。通过配置简单的工作流文件，开发者能够触发构建、测试和部署代码的过程，无需手动干预。

快速入门步骤

创建工作流文件

首先，在项目中创建一个名为 .github/workflows 的目录，并在其中添加一个新的 YAML 文件。通常会以特定的用途命名此文件，例如 build.yml 或者 test.yml。以下是创建文件的基本步骤：

登录 GitHub 账号并进入目标仓库。
导航至仓库中的 .github/workflows 目录（如果不存在则创建）。
创建一个新的 YAML 文件。

编写工作流代码

接下来，编辑这个新文件来定义工作流。基础的工作流包括一个触发事件和一系列任务，如编译代码或运行测试。下面是一个简单的例子：

name: CI

on:
  push:
    branches:
      - main

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

      - name: Set up Node.js
        uses: actions/setup-node@v2
        with:
          node-version: '14.x'

      - name: Install dependencies
        run: npm install

      - name: Run tests
        run: npm test

在上面的例子中，每当 main 分支发生推送时，GitHub Actions 会自动运行此工作流。该流程包含几个步骤：检出仓库代码、设置 Node.js 环境、安装依赖以及执行测试。

配置和安全注意事项

权限控制：确保只有授权用户可以修改 .github/workflows 目录中的文件，以防止未经授权的更改影响项目的安全性和稳定性。
敏感信息管理：在工作流中使用任何敏感信息（如 API 密钥）时，请通过 GitHub Secrets 存储这些信息，并且仅在必要步骤中引用它们。避免将敏感数据硬编码到 YAML 文件中。
任务日志审查：定期检查工作流的日志，以便于及时发现和解决问题。