后端开发工程师-DevOps与自动化部署-GitHub_GitHubActions：自动化工作流.docx

PAGE1

PAGE1

GitHubActions简介与原理

GitHubActions是GitHub提供的一种自动化工具，允许开发者在代码发生变更时自动触发一系列自定义的工作流程。这些工作流程可以包括构建、测试、部署代码，甚至运行安全扫描等。通过GitHubActions，开发者可以将这些重复性的任务自动化，提高开发效率和代码质量。

1原理

GitHubActions的核心是工作流（Workflow），它是一个YAML格式的文件，定义了当特定事件发生时，GitHub应该执行的一系列任务。这些事件可以是代码推送到仓库、创建或关闭pullrequest、创建或更新issue等。工作流文件通常存储在仓库的.github/workflows目录下。

工作流文件中定义的任务（Job）是在虚拟环境中运行的，这些环境可以是GitHub提供的预设环境，也可以是自定义的Docker容器。每个任务可以包含多个步骤（Step），这些步骤可以是运行shell命令、调用预定义的action或者使用自定义的action。

GitHubActions的执行流程如下：

当仓库中定义的事件发生时，GitHub会读取.github/workflows目录下的YAML文件。

根据YAML文件中的定义，GitHub会创建一个工作流运行实例。

工作流运行实例会根据定义的任务和步骤，在虚拟环境中执行相应的操作。

执行结果会被记录并显示在GitHub的工作流运行日志中。

2示例

下面是一个简单的GitHubActions工作流文件示例，用于在代码推送到仓库时自动运行单元测试：

name:CI

on:

push:

branches:[main]

pull_request:

branches:[main]

jobs:

build:

runs-on:ubuntu-latest

steps:

-uses:actions/checkout@v2

-name:SetupPython

uses:actions/setup-python@v2

with:

python-version:3.8

-name:Installdependencies

run:|

python-mpipinstall--upgradepip

pipinstall-rrequirements.txt

-name:Runtests

run:|

python-mpytesttests/

2.1解释

name:CI：定义工作流的名称。

on:：定义触发工作流的事件，这里定义了当代码推送到main分支或创建指向main分支的pullrequest时触发。

jobs:：定义工作流中的任务，这里只有一个build任务。

runs-on:：定义任务运行的环境，这里使用的是Ubuntu必威体育精装版版本。

steps:：定义任务中的步骤，这里包括：

uses:actions/checkout@v2：检查出仓库的代码。

name:SetupPython：设置Python环境。

uses:actions/setup-python@v2：使用预定义的action设置Python环境。

with:：定义action的参数，这里设置Python版本为3.8。

name:Installdependencies：安装依赖。

run:：运行shell命令，这里使用pip安装requirements.txt中的依赖。

name:Runtests：运行测试。

run:：运行shell命令，这里使用pytest运行tests/目录下的测试。

1工作流文件结构与语法

GitHubActions的工作流文件使用YAML格式编写，主要包含以下部分：

name：工作流的名称。

on：定义触发工作流的事件。

jobs：定义工作流中的任务。

runs-on：定义任务运行的环境。

steps：定义任务中的步骤。

uses：调用预定义的action。

with：定义action的参数。

run：运行shell命令。

1.1示例

下面是一个更复杂的工作流文件示例，用于在代码推送到仓库时自动构建、测试和部署代码：

name:CI/CDPipeline

on:

push:

branches: