前言

Github Actions 是 Microsoft 收购 GitHub 后推出的 CI/CD 服务，它提供了配置非常不错的虚拟服务器环境（E5 2vCPU/7G RAM），基于它可以进行构建、测试、打包、部署项目。对于公共仓库可免费无时间限制的使用（指累积时间），不过要使用它首先需要知道如何编写 workflow 文件。但这篇文章并不是教你如何枯燥的去编写 workflow 文件，而是教你如何去使用博主已经编写好的方案去编译 OpenWrt。

教程更新

• 2020-04-25 更新 DIY 脚本说明、添加自定义 feeds 配置文件说明
• 2020-04-09 新增上传固件到 WeTransfer
• 2020-03-30 新增上传固件到奶牛快传
• 2020-02-01 新图文教程
• 2019-12-10 新增 macOS 编译方案使用说明
• 2019-12-06 添加 tmate 网页终端链接说明
• 2019-12-05 优化基础使用教程，添加 @lietxia 大佬的图文教程链接
• 2019-12-04 新增云menuconfig使用方法
• 2019-12-03 新增并发编译使用方法
• 2019-11-30 新增自定义源码编译使用方法
• 2019-11-14 全网独家首发

方案特点

• 免费
• 一键快速编译
• 定时自动编译
• 客制化编译
• 并发编译（可同时进行20+5个编译任务）
• 无需搭建编译环境（在线make menuconfig生成配置文件)
• 无需消耗自己的计算机与服务器的计算资源（性感E5在线编译）
• 无需担心磁盘空间不足（近60G磁盘空间）
• 无需使用清理文件（内核更新不怕 boom ）
• 编译速度快（编译时间1-2小时）
• 编译成功率提升200%（万兆自由网络环境）
• 全新环境（杜绝编译环境不干净导致编译失败）

本解决方案是一个开放平台，任何人都可以基于此打造自己专属的编译方案。

项目地址

https://github.com/P3TERX/Actions-OpenWrt

支持项目请随手点个star，让更多的人发现、使用并受益。

准备工作

• 注册 GitHub 账号
• 搭建编译环境，用于生成.config文件。(可选)

TIPS: 关于编译环境的搭建，推荐去看我之前写的相关文章，Windows 10 可以使用 WSL ，macOS、Linux 可以使用 Docker 。

基础使用

首先你必须要熟悉整个 OpenWrt 的编译过程，这会让你非常容易的理解如何使用 GitHub Actions 进行编译，即使你没有成功过。因为实际上本地编译近 90% 失败的原因是因为网络问题导致的，中国大陆特色，咱也不敢多说。而使用 GitHub Actions 编译成功率至少提升 200% ，为什么这样说呢？因为 Actions 服务器由 Microsoft Azure 提供，在自由的美利坚，拥有万兆带宽。

首次编译

• 在自己搭建编译环境中使用 Lean's OpenWrt 源码生成.config文件。（或使用后面进阶玩法中的云menuconfig，直接 SSH 到 Actions 进行操作）

TIPS: 方案默认引用 Lean 的源码，因为他的 README 影响了我开始学习编译，也就有了这个项目，而且他的源码非常的优秀。有其它需求可自行修改 workflow 文件，方法后面的进阶使用中有说明。

• 进入 P3TERX/Actions-OpenWrt 项目页面，点击页面中的 Use this template （使用这个模版）按钮。

• 填写仓库名称，然后点击Create repository from template（从模版创建储存库）按钮。

• 经过几秒钟的等待，页面会跳转到新建的仓库，内容和我的项目是相同的。然后点击Create new file（创建新文件）按钮。

• 文件名填写为.config，把生成的.config 文件的内容复制粘贴到下面的文本框中。

• 翻到页面最下方，点击Commit new file（提交新文件）按钮即可。后续编译工作会自动开始，你可以在 Actions 页面进行查看。

• 在等待编译完成的过程中，你可以进入这个页面点击右上角的star，这是对博主最大的支持，而且还可以加快编译速度哦（雾
• 最后经过一两个小时的等待，不出意外你就可以在 Actions 页面看到已经打包好的固件目录压缩包。

TIPS: 如需 ipk 文件可以在进阶使用章节找到方法。因为大多数人只需要固件，而且总是有萌新问固件在哪，所以现在默认只上传固件。

再次编译

默认情况下触发编译工作流程有两种方式：

1. 发布 release
2. 修改.config文件

他们分别对应以下使用场景：

• 在编译配置没有修改的情况下，你发现大佬的仓库源码有更新，那么在 releases 页面发布一个 release 将直接触发编译的工作流程，使用最新源码进行编译。
• 如果你想修改配置，则生成船新的.config文件 push 到仓库来触发编译的工作流程。

其它触发方式你可以在后面的进阶使用中看到。

进阶使用

自定义环境变量与功能

env:
  REPO_URL: https://github.com/coolsnowwolf/lede
  REPO_BRANCH: master
  FEEDS_CONF: feeds.conf.default
  CONFIG_FILE: .config
  DIY_P1_SH: diy-part1.sh
  DIY_P2_SH: diy-part2.sh
  SSH_ACTIONS: false
  UPLOAD_BIN_DIR: false
  UPLOAD_FIRMWARE: true
  UPLOAD_COWTRANSFER: false
  UPLOAD_WETRANSFER: false
  TZ: Asia/Shanghai

DIY 脚本

仓库根目录目前有两个 DIY 脚本：diy-part1.sh和diy-part2.sh，它们分别在更新与安装 feeds 的前后执行，你可以把对源码修改的指令写到脚本中，比如修改默认IP、主机名、主题、添加/删除软件包等操作。但不仅限于这些操作，发挥你强大的想象力，可做出更强大的功能。

TIPS: 脚本工作目录在源码目录，内附几个简单的例子供参考。

添加额外的软件包

• 在 DIY 脚本中加入对指定软件包源码的远程仓库的克隆指令。就像下面这样：

git clone https://github.com/P3TERX/xxx package/xxx

• 本地make menuconfig生成.config文件时添加相应的软件包，如果你知道包名可以直接写到.config文件中。

TIPS: 如果额外添加的软件包与 OpenWrt 源码中已有的软件包同名的情况，则需要把 OpenWrt 源码中的同名软件包删除，否则会优先编译 OpenWrt 中的软件包。这同样可以利用到的 DIY 脚本，相关指令应写在diy-part2.sh。

原理是把软件包源码放到package目录下，编译时会自动遍历，与本地编译是一样的。当然方法不止一种，其它方式请自行探索。

自定义 feeds 配置文件

把feeds.conf.default文件放入仓库根目录即可，它会覆盖 OpenWrt 源码目录下的相关文件。

Custom files（自定义文件）

俗称“files 大法”，在仓库根目录下新建files目录，把相关文件放入即可。有关详情请自行搜索了解。

定时自动编译

#  schedule:
#    - cron: 0 8 * * 5

真·一键编译（点击 star 开始编译）

点击自己仓库页面上的 Star 按钮开始编译，为了防止产生垃圾记录，所以这个功能默认没有开启。

#  watch:
#    types: started

自定义源码编译

此方案默认引用的是 Lean 的源码，如果你有编译其它源码的需求可以进行替换，自由是本解决方案最大的特点。

        REPO_URL: https://github.com/coolsnowwolf/lede
        REPO_BRANCH: master

        REPO_URL: https://github.com/openwrt/openwrt
        REPO_BRANCH: openwrt-19.07

并发编译（同时编译多个固件）

多 repository 方案

通过 P3TERX/Actions-OpenWrt 项目创建多个仓库来编译不同架构机型的 OpenWrt 固件。

多 workflow 方案

基于 GitHub Actions 可同时运行多个工作流程的特性，最多可以同时进行至少20个编译任务。也可以单独选择其中一个进行编译，这充分的利用到了 GitHub Actions 为每个账户免费提供的20个 Ubuntu 虚拟服务器环境。此外你还可以额外再使用5个 macOS 虚拟服务器环境进行编译，开启方法在后面有说明。

...
    paths:
      - '.config'
...
        CONFIG_FILE: '.config'
        DIY_SH: 'diy.sh'
...

云 menuconfig（SSH 连接到 Actions）

通过 tmate 连接到 GitHub Actions 虚拟服务器环境，可直接进行make menuconfig操作生成编译配置，或者任意的客制化操作。也就是说，你不需要再自己搭建编译环境了。这可能改变之前所有使用 GitHub Actions 的编译 OpenWrt 方式。

SSH_ACTIONS: true

To connect to this session copy-n-paste the following into a terminal or browser:

ssh Y26QeagDtsPXp2mT6me5cnMRd@nyc1.tmate.io

https://tmate.io/t/Y26QeagDtsPXp2mT6me5cnMRd

macOS 编译方案

上传固件到奶牛快传

奶牛快传是中国大陆的一款临时文件传输分享服务网盘，特点是不限速。因国情所致，中国大陆地区 GitHub 访问速度缓慢，有些小伙伴可能无法正常下载固件，上传固件到奶牛快传是个非常好的选择。

UPLOAD_COWTRANSFER: true

上传固件到 WeTransfer

WeTransfer 是荷兰的一款临时文件传输分享服务网盘，前面提到的奶牛快传实际上师从自它，二者的网站都非常相似。WeTransfer 使用的是 Amazon S3 存储并通过 Amazon CloudFront CDN 全球加速，它在中国大陆的下载体验完全不输奶牛快传，甚至某些情况下要更好。

UPLOAD_WERANSFER: true

上传固件到 release

尾巴

希望大家合理使用免费的资源，必要时再编译，过度占用资源虽然使用者不会得到任何实质性的惩罚，但会为中国抹黑，造成很多国际争端。只有让开发者来充分利用才能产生更多更好的软件，这样大家才能受益。最后感谢 Microsoft 为我们提供 GitHub Actions 这样强大的工具。

相关 TG 群组：GitHub Actions Group

相关 TG 频道：GitHub Actions Channel

本博客已开设 Telegram 频道，欢迎小伙伴们订阅关注。

本文作者：P3TERX

本文链接：https://p3terx.com/archives/build-openwrt-with-github-actions.html

版权声明：本博客所有文章除特别声明外，均采用 CC BY-NC-SA 4.0 许可协议。非商业转载及引用请注明出处（作者、原文链接），商业转载请联系作者获得授权。