Github Actions学习：从入门到实践的简单教程

本文提供了关于Github Actions学习的全面指南，涵盖了从基本概念到高级使用的各个层面。你将了解到如何配置工作流文件、设置触发条件和执行任务，以及如何进行代码检查和部署应用。此外，文章还介绍了依赖管理和多环境支持的进阶使用方法。

Github Actions的基本概念

Github Actions是一个由GitHub提供的自动化工作流平台，它允许开发者通过自动化软件开发生命周期中的任务（如构建、测试、部署等）来提高开发效率。使用GitHub Actions，你可以创建自动化脚本来实现各种功能，例如代码构建、代码质量检查、单元测试、持续集成、持续部署等。

Github Actions的优势和应用场景

GitHub Actions的主要优势包括：

1. 无需搭建和维护基础设施：开发者无需关心服务器的搭建和维护，直接使用GitHub提供的服务即可。
2. 灵活配置：支持各种开发语言和框架，可以灵活地配置工作流以适应不同的开发环境和需求。
3. 集成性强：可以与GitHub的其他功能（如PR、Issues等）无缝集成，帮助开发者更高效地协作和管理项目。
4. 易扩展：通过插件和自定义操作，可以进一步扩展GitHub Actions的能力，满足复杂和特定需求。

应用场景包括但不限于：

• 持续集成：自动构建和测试代码，确保代码质量。
• 持续部署：自动化部署应用到不同的环境，如测试环境、预生产环境和生产环境。
• 代码审查：执行代码审查任务，确保代码符合团队的标准。
• 构建文档：自动生成文档，并发布到指定位置。

Github Actions的文件结构

GitHub Actions的配置文件通常放在项目的.github/workflows/目录下。每个工作流都是一个独立的.yml文件，配置了工作流的触发条件和执行的任务。一个典型的文件结构如下：

.github/
└── workflows/
    └── example.yml

工作流（Workflow）的基本语法

工作流文件由多个关键部分组成，包括：

1. on：定义触发工作流的事件。
2. jobs：定义一组任务，每个任务可以包含多个步骤。
3. steps：定义任务的具体步骤，每个步骤执行特定的操作。

下面是一个基础的工作流文件示例：

name: Example Workflow

on:
  push:
    branches:
      - main

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository code
      uses: actions/checkout@v3

    - name: Run a single command
      run: echo Hello, world!

这个工作流会在main分支上的任何代码推送时触发，包含一个名为build的任务，该任务在最新的Ubuntu机器上运行，首先检出仓库代码，然后运行一个简单的命令。

创建第一个Github Actions工作流

为了创建第一个GitHub Actions工作流，我们按照以下步骤操作：

1. 创建一个新的.yml文件：在项目的./github/workflows/目录下创建一个新的.yml文件。例如，我们可以创建一个名为ci.yml的文件。
2. 配置工作流：在ci.yml文件中添加以下内容，定义一个简单的持续集成工作流。

name: CI

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

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository code
      uses: actions/checkout@v3

    - name: Run tests
      run: python -m unittest discover

这个工作流定义了两个触发条件：

• 当main分支上的代码有推送时。
• 当向main分支提交一个新的pull request时。

在build任务中，它首先检出仓库代码，然后运行Python的单元测试。

设置触发条件和执行任务

一个工作流可以包含多个任务，每个任务都是一个jobs。每个任务可以包含多个步骤，每个步骤都是一个steps。

例如，如果我们要添加一个构建任务，可以在build任务中添加一个构建步骤：

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository code
      uses: actions/checkout@v3

    - name: Install dependencies
      run: pip install -r requirements.txt

    - name: Run tests
      run: python -m unittest discover

    - name: Build application
      run: echo Building the application

在这个例子中，我们添加了一个安装依赖的步骤。首先检出仓库代码，然后安装依赖项，运行测试，最后执行一个简单的构建步骤。

如何进行代码检查

代码检查是确保代码质量的重要步骤。GitHub Actions提供了多种工具来执行代码检查，例如CodeQL、ESLint等。

例如，我们可以使用CodeQL来分析代码质量。首先，需要定义一个使用CodeQL工具的步骤：

- name: Run CodeQL analysis
  uses: github/codeql-action/analyze@v2

以下是包含代码检查的完整工作流示例：

name: CI with CodeQL

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

jobs:
  build:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository code
      uses: actions/checkout@v3

    - name: Run tests
      run: python -m unittest discover

    - name: Run CodeQL analysis
      uses: github/codeql-action/analyze@v2

如何部署应用

部署应用是将应用部署到生产环境的过程。GitHub Actions可以轻松地完成这一任务，例如，使用Heroku部署应用。

以下是一个示例，使用GitHub Actions部署一个简单的Python应用到Heroku：

1. 安装Heroku CLI：我们首先需要安装Heroku CLI。

- name: Install Heroku CLI
  run: |
    curl https://cli-assets.heroku.com/branches/stable/heroku-$(uname | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/amd64/g').tar.gz > heroku.tar.gz
    tar -xvf heroku.tar.gz
    mv heroku /usr/local/bin

1. 配置Heroku应用：我们需要设置Heroku应用的环境变量，并登录Heroku。

- name: Set up Heroku
  env:
    HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
    HEROKU_APP_NAME: ${{ secrets.HEROKU_APP_NAME }}
  run: |
    heroku auth:login
    heroku apps:create $HEROKU_APP_NAME
    heroku config:set \
      API_KEY=$HEROKU_API_KEY \
      DATABASE_URL=postgres://user:pass@host:port/dbname \
      SECRET_KEY=supersecret

1. 部署应用：最后，我们需要将应用部署到Heroku。

- name: Deploy to Heroku
  env:
    HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
  run: |
    heroku git:remote -a $HEROKU_APP_NAME
    git push heroku main

完整的工作流文件如下：

name: Deploy to Heroku

on:
  push:
    branches:
      - main

jobs:
  deploy:
    runs-on: ubuntu-latest

    steps:
    - name: Check out repository code
      uses: actions/checkout@v3

    - name: Install Heroku CLI
      run: |
        curl https://cli-assets.heroku.com/branches/stable/heroku-$(uname | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/amd64/g').tar.gz > heroku.tar.gz
        tar -xvf heroku.tar.gz
        mv heroku /usr/local/bin

    - name: Set up Heroku
      env:
        HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
        HEROKU_APP_NAME: ${{ secrets.HEROKU_APP_NAME }}
      run: |
        heroku auth:login
        heroku apps:create $HEROKU_APP_NAME
        heroku config:set \
          API_KEY=$HEROKU_API_KEY \
          DATABASE_URL=postgres://user:pass@host:port/dbname \
          SECRET_KEY=supersecret

    - name: Deploy to Heroku
      env:
        HEROKU_API_KEY: ${{ secrets.HEROKU_API_KEY }}
      run: |
        heroku git:remote -a $HEROKU_APP_NAME
        git push heroku main

依赖管理与缓存

依赖管理是确保项目能够在不同环境中正确构建的关键。GitHub Actions提供了依赖缓存功能，以加快构建速度。

例如，对于Python项目，可以使用actions/cache@v3操作缓存pip下载的依赖项：

- name: Cache pip dependencies
  uses: actions/cache@v3
  with:
    path: ~/.cache/pip
    key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
    restore-keys: |
      ${{ runner.os }}-pip-

这个步骤会缓存pip下载的依赖项，下次构建时如果依赖项未变，则会直接从缓存中读取，从而加快构建速度。

多环境支持

多环境支持是开发大型应用时的常见需求。GitHub Actions允许你定义不同的环境，并根据不同的条件执行不同的步骤。

例如，可以定义一个工作流，该工作流根据环境变量ENV的不同执行不同的步骤：

jobs:
  build:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        env: [dev, test, prod]

    steps:
    - name: Check out repository code
      uses: actions/checkout@v3

    - name: Set up Python
      uses: actions/setup-python@v3
      with:
        python-version: '3.8'

    - name: Install dependencies
      run: pip install -r requirements.txt

    - name: Run tests
      if: ${{ matrix.env == 'test' }}
      run: python -m unittest discover

    - name: Build application
      if: ${{ matrix.env == 'prod' }}
      run: echo Building the application

在这个示例中，我们定义了一个矩阵策略，根据不同的env变量执行不同的步骤。如果env为test，则执行测试步骤；如果env为prod，则执行构建步骤。

常见问题及解决办法

在使用GitHub Actions的过程中，可能会遇到一些常见的问题。以下是一些常见的问题及其解决办法：

1. 工作流没有正确触发：

   • 确保触发条件正确配置。
   • 检查是否有任何其他工作流正在接管事件。
   • 确保.github/workflows/目录下的文件权限正确。

2. 工作流执行失败：

   • 仔细检查日志，找到失败的具体步骤。
   • 检查是否有任何依赖项未正确安装。
   • 确保所有步骤的命令在相应的环境上都能正常执行。
3. 步骤时间较长：
   • 优化步骤中的命令，确保它们尽可能高效。
   • 使用缓存来减少重复下载或构建的时间。

如何查看工作流的执行日志

通过查看工作流的执行日志，可以更好地了解工作流的执行情况。你可以在GitHub仓库的Actions部分查看每个工作流的详细日志。

1. 访问Actions部分：点击仓库页面顶部的Actions选项卡。
2. 选择要查看的工作流：选择要查看的工作流。
3. 查看日志：点击工作流运行的详细信息，然后在右侧查看日志。

日志中会显示每个步骤的输出，帮助你快速定位问题。