2024年4月14日发(作者：)

Github Actions 编译

一、简介

Github Actions 是 Github 平台上的代码自动化工具，它允许开发者在代码库中

配置各种操作，例如自动化编译、测试、部署等。本文将详细介绍如何使用

Github Actions 进行编译。

二、为什么选择 Github Actions

Github Actions 作为一个持续集成（CI）工具，具有以下优势：

1. 无服务器：Github Actions 在 Github 平台上提供了无服务器的环境，不

需要额外的部署和管理，开箱即用。

2. 简单易用：Github Actions 的配置文件使用 YAML 语言编写，语法简洁明

了，容易上手。

3. 强大的生态系统：Github Actions 与 Github 平台紧密集成，许多开源项

目的 CI/CD 工作流都已经在 Github Actions 社区中得到了广泛的分享和

使用。

4. 免费使用：Github Actions 提供一定的免费使用额度，对于小型项目来说

非常友好。

三、配置编译流程

在项目的根目录下创建

.github/workflows

文件夹，并在该文件夹中创建一个

以

.yml

结尾的配置文件（例如

）来定义编译流程。

name: 编译流程

on: [push, pull_request]

jobs:

build:

runs-on: ubuntu-latest

steps:

- name: 检出代码

uses: actions/checkout@v2

- name: 设置 环境

uses: actions/setup-node@v2

with:

node-version: '14'

- name: 安装依赖

run: npm install

- name: 编译代码

run: npm run build

上述配置文件定义了一个名为

build

的工作流，用于在每次推送（push）或拉取

请求（pull_request）时触发。具体流程包括检出代码、设置 环境、安

装依赖和编译代码。

四、触发条件设置

在上述示例中，工作流在每次推送和拉取请求时触发。你还可以根据需要设置更多

的触发条件，例如：

•

•

•

•

•

on: schedule

：定时触发，例如每天或每周执行一次。

on: release

：发布新版本时触发。

on: issue_comment

：在 Issue 评论中包含特定关键字时触发。

on: repository_dispatch

：通过 API 调用手动触发。

……

根据实际需求，灵活设置触发条件可以确保编译流程在恰当的时间运行，并且最大

限度地提高开发效率。

五、自定义编译流程

除了上述示例中的基本编译流程，你还可以根据自己的项目需求进行更多的自定义。

分支触发

可以通过添加

branches

字段来指定只有特定分支的推送或拉取请求才触发工作流。

on:

push:

branches:

- master

- develop

pull_request:

branches:

- master

- develop

构建矩阵

如果项目需要在不同的操作系统、不同版本的语言环境或不同的配置下进行编译，

可以通过

来定义构建矩阵。

name: 编译流程

on: [push, pull_request]

jobs:

build:

runs-on: ${{ }}

strategy:

matrix:

os: [ubuntu-latest, windows-latest, macos-latest]

node-version: [12, 14, 16]

steps:

- name: 检出代码

uses: actions/checkout@v2

- name: 设置 环境

uses: actions/setup-node@v2

with:

node-version: ${{ -version }}

- name: 安装依赖

run: npm install

- name: 编译代码

run: npm run build

上述示例中，

定义了两个变量

os

和

node-version

，分别用于指

定操作系统和 版本。这样可以在不同的操作系统和版本下并行构建，提

高整体编译速度。

缓存依赖

为了提高编译性能，可以使用缓存来保存项目的依赖。

name: 编译流程

on: [push, pull_request]

jobs:

build:

runs-on: ubuntu-latest

steps:

- name: 检出代码

uses: actions/checkout@v2

- name: 设置 环境

uses: actions/setup-node@v2

with:

node-version: '14'

- name: 恢复缓存

uses: actions/cache@v2

with:

path: ~/.npm

key: ${{ }}-node-${{ hashFiles('**/') }}

- name: 安装依赖

run: npm install

- name: 编译代码

run: npm run build

- name: 保存缓存

uses: actions/cache@v2

with:

path: ~/.npm

key: ${{ }}-node-${{ hashFiles('**/') }}

上述示例中，

actions/cache

插件用于缓存

~/.npm

目录，避免每次安装依赖都需

要下载。

总结

本文介绍了如何使用 Github Actions 进行编译，并通过实际示例展示了配置编译

流程、设置触发条件、自定义编译流程等内容。Github Actions 提供了一个简单

而强大的自动化工具，可以极大地提高项目的开发效率。

如果你还没有尝试过 Github Actions，赶快在你的项目中配置一下吧！相信它会

带给你很多惊喜和便利。