GitHub 工作流配置详解

最新推荐文章于 2024-05-27 23:30:28 发布

你若向前

最新推荐文章于 2024-05-27 23:30:28 发布

阅读量581

点赞数 7

分类专栏： git 文章标签： github

本文链接：https://blog.csdn.net/StoryZX/article/details/135053248

版权

git 专栏收录该内容

4 篇文章 0 订阅

订阅专栏

GitHub 工作流配置详解

GitHub 工作流是一种有效的协作方式，能够提高团队的开发效率。通过配置工作流，你可以规范团队的协作流程，自动化代码构建、测试和部署。在本博客中，我们将深入了解 GitHub Actions，这是 GitHub 提供的一种强大的工作流配置工具，以及如何在你的项目中配置自定义的工作流。

1. GitHub Actions 简介

GitHub Actions 是 GitHub 提供的一项集成服务，可帮助你在代码仓库中自动执行多个任务，例如构建、测试、部署等。每个 GitHub 仓库都可以配置一个或多个工作流程，通过 .github/workflows 目录中的 YAML 文件定义。让我们从头开始创建一个简单的工作流程。

2. 创建工作流文件

在你的 GitHub 仓库中创建一个名为 .github/workflows 的目录，然后在该目录下创建一个 YAML 文件，例如 build-test-deploy.yml。

mkdir -p .github/workflows
touch .github/workflows/build-test-deploy.yml

3. 编写工作流配置

打开 build-test-deploy.yml 文件，开始编写工作流程的配置。以下是一个基本的示例，演示了一个包含构建、测试和部署步骤的工作流程。

name: Build, Test, and Deploy

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'

    - name: Install Dependencies
      run: npm install

    - name: Build
      run: npm run build

  test:
    runs-on: ubuntu-latest

    needs: build

    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2

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

    - name: Install Dependencies
      run: npm install

    - name: Run Tests
      run: npm test

  deploy:
    runs-on: ubuntu-latest

    needs: test

    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2

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

    - name: Install Dependencies
      run: npm install

    - name: Deploy to Production
      run: npm run deploy

这个示例工作流程包括三个作业（jobs）：build、test 和 deploy。它在 main 分支上监听 push 事件，当有代码推送到 main 分支时触发。

4. 自定义工作流

你可以根据你的项目需求自定义工作流程。配置文件中的 jobs 部分定义了每个作业的执行步骤，你可以添加、删除或修改这些步骤以满足项目的具体要求。同时，GitHub Actions 支持许多预定义的操作，你可以在 GitHub Marketplace 中找到并集成到你的工作流程中。

5. 触发条件和定时任务

在 on 部分可以配置工作流程触发的条件。例如，你可以设置只有在 push 到特定分支或打标签时触发工作流程。

on:
  push:
    branches:
      - main

你还可以通过 schedule 触发工作流程的定时任务。

on:
  schedule:
    - cron: '0 0 * * *'

上述配置表示每天UTC时间的午夜（0 0 * * *）触发一次工作流程。

6. 安全性配置

为了确保工作流程的安全性，你可以配置 secrets 以保护敏感信息。在仓库的 Settings -> Secrets 页面中添加机密信息，并在工作流程中使用它们。

jobs:
  deploy:
    runs-on: ubuntu-latest

    needs: test

    steps:
    - name: Checkout Repository
      uses: actions/checkout@v2

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

    - name: Install Dependencies
      run: npm install

    - name: Deploy to Production
      run: npm run deploy
      env:
        SECRET_KEY: ${{ secrets.DEPLOY_SECRET_KEY }}