RT-Thread-如何本地运行和测试 Github ActionsRT-Thread问答社区

如何本地运行和测试 Github Actions

发布于 2023-06-14 10:35:43 浏览：1632 订阅该版

[tocm]

# 前言

一般来说，使用 Github Actions 都需要在 Repo 里完成相应的 event 才能够触发（比如push/pull_request等），然后在 Github 提供的服务器（容器）中运行。这样有两个缺点：

* 每次都需要在 Repo 完成相应的 evenet，操作较为费时。
* 一个 event 可能会触发多个 Action，并且在 Github 的服务器上运行时需要排队，运行较为耗时。

所以，本文介绍如何在本地运行 Github Actions 来解决上述两个问题，主要有以下两个依赖：

* Docker Desktop on Windows（Backend 是 WSL）
* act

# 依赖安装

## Docker Desktop on Windows

安装 Docker Desktop on Windows 前需要先安装 WSL，安装 WSL 的操作可以参考官方文档，[较老版本的 Windows 可以参考此处](https://learn.microsoft.com/zh-cn/windows/wsl/install-manual)，[较新版本的 Windows 可以参考此处](https://learn.microsoft.com/zh-cn/windows/wsl/install)。

安装 Docker Desktop on Windows，可以直接从 [Install Docker Desktop on Windows | Docker Documentation](https://docs.docker.com/desktop/install/windows-install/) 下载，一键式安装。

> 进入 Docker Desktop on Windows 时可能会一直停留在 starting the docker engine 界面，可以考虑以下解决方法：
>
> 1. 重启 Docker 服务
>
> net stop com.docker.service
>
> net start com.docker.service
>
> 2. 先点击右上角登录 Docker 账号

## act

act 是在本地运行 Github Actions 的工具，它依赖于 Docker。安装可以参考 [nektos/act: Run your GitHub Actions locally 🚀](https://github.com/nektos/act#installation-through-package-managers)，或者直接在这个仓库的 [release](https://github.com/nektos/act/releases) 当中下载，只有一个 Windows 可执行文件（exe）。

# 本地运行 Github Actions

## act 使用说明

```bash
# Command structure:
act [<event>] [options]
If no event name passed, will default to "on: push"
If actions handles only one event it will be used as default instead of "on: push"

# List all actions for all events:
act -l

# List the actions for a specific event:
act workflow_dispatch -l

# List the actions for a specific job:
act -j test -l

# Run the default (`push`) event:
act

# Run a specific event:
act pull_request

# Run a specific job:
act -j test

# Collect artifacts to the /tmp/artifacts folder:
act --artifact-server-path /tmp/artifacts

# Run a job in a specific workflow (useful if you have duplicate job names)
act -j lint -W .github/workflows/checks.yml

# Run in dry-run mode:
act -n

# Enable verbose-logging (can be used with any of the above commands)
act -v
```

## 示例：RT-Thread 的 Github Actions

1. 进入 RT-Thread 源代码目录（只要进入第一层即可，act 会自动搜索 .github/workflow  目录）
2. 使用`act -l`查看当前目录下的 Action

![screenshot_image.png](https://oss-club.rt-thread.org/uploads/20230614/fe3cf9e743bc7862eb309183d804e216.png.webp)

3. 可以看到有重名（Job ID）的 Action，所以需要指定要运行的 Action（`act -j test -W .\.github\workflows\action_tools.yml`）

> 如果运行时拉不下镜像可以修改一下 daemon.json 中的镜像源
```json
"registry-mirrors": [
    "https://registry.docker-cn.com",
    "http://hub-mirror.c.163.com",
    "https://docker.mirrors.ustc.edu.cn"
  ]
```

运行结果如下：

![screenshot_image.png](https://oss-club.rt-thread.org/uploads/20230614/229cbe6d476571729112f1d8a3d87f7e.png.webp)

![screenshot_51a.png](https://oss-club.rt-thread.org/uploads/20230614/a7066ed65ff44557bfc9115d127cc5d3.png.webp)