Skip to content

Latest commit

 

History

History
84 lines (67 loc) · 6.92 KB

README.ACTION.md

File metadata and controls

84 lines (67 loc) · 6.92 KB

Github Actions 打包脚本使用说明

支持一键打包目前已经支持的全部 OpenWrt 固件，如贝壳云、我家云、微加云，以及 Amlogic S9xxx 系列型号如 s922x、s905x3、s905x2、s905d，s905，s912 等。

使用方法

在 .github/workflows/*.yml 云编译脚本中引入此 Actions 即可进行打包，代码如下：

- name: Package Armvirt as OpenWrt
  uses: unifreq/openwrt_packit@master
  env:
    OPENWRT_ARMVIRT: openwrt/bin/targets/*/*/*rootfs.tar.gz
    PACKAGE_SOC: s905d_s905x3_s922x_vplus_beikeyun_l1pro
    KERNEL_VERSION_NAME: 5.15.35_5.17.5

打包好的固件在 ${{ env.PACKAGED_OUTPUTPATH }}/* ，可以上传至 github.com 的 Releases 中，代码如下：

- name: Upload OpenWrt Firmware to Release
  uses: ncipollo/release-action@main
  with:
    tag: openwrt_armvirt_v8_${{ env.PACKAGED_OUTPUTDATE }}
    artifacts: ${{ env.PACKAGED_OUTPUTPATH }}/*
    allowUpdates: true
    token: ${{ secrets.GH_TOKEN }}
    body: |
      This is OpenWrt firmware for Armvirt 64
      * Firmware information
      Default IP: 192.168.1.1
      Default username: root
      Default password: password

可选参数说明

可以对 打包文件、make.env、选择内核版本、选择盒子SoC 等参数进行个性化配置。

参数 默认值 说明
OPENWRT_ARMVIRT_PATH no 必选项. 设置 openwrt-armvirt-64-default-rootfs.tar.gz 的文件路径，可以使用相对路径如 openwrt/bin/targets/*/*/*.tar.gz 或 网络文件下载地址如 https://github.com/*/releases/*/*.tar.gz
KERNEL_REPO_URL breakings/.../kernel 设置内核下载地址，默认从 breakings 维护的 kernel 库里下载 Flippy 的内核。
KERNEL_VERSION_NAME 5.15.35_5.17.5 设置内核版本，kernel 库里收藏了众多 Flippy 的原版内核，可以查看并选择指定。可指定单个内核如 5.15.35 ，可选择多个内核用_连接如 5.15.35_5.17.5 ，内核名称以 kernel 目录中的文件夹名称为准。
KERNEL_AUTO_LATEST true 设置是否自动采用同系列最新版本内核。当为 true 时，将自动在内核库中查找在 KERNEL_VERSION_NAME 中指定的内核如 5.15.35 的同系列是否有更新的版本，如有更新版本时，将自动更换为最新版。设置为 false 时将编译指定版本内核。
PACKAGE_SOC s905d_s905x3_beikeyun 设置打包盒子的 SOC ，默认 all 打包全部盒子，可指定单个盒子如 s905x3 ，可选择多个盒子用_连接如 s905x3_s905d 。各盒子的SoC代码为：vplus beikeyun l1pro s905 s905d s905x2 s905x3 s912 s922x s922x-n2 diy。说明：s922x-n2 是 s922x-odroid-n2, diy 是自定义盒子。
GZIP_IMGS auto 设置打包完毕后文件压缩的格式，可选值 .gz（默认） / .xz / .zip / .zst / .7z
SELECT_PACKITPATH openwrt_packit 设置 /opt 下的打包目录名称
SELECT_OUTPUTPATH output 设置 ${SELECT_PACKITPATH} 目录中固件输出的目录名称
SCRIPT_VPLUS mk_h6_vplus.sh 设置打包 h6 vplus 的脚本文件名
SCRIPT_BEIKEYUN mk_rk3328_beikeyun.sh 设置打包 rk3328 beikeyun 的脚本文件名
SCRIPT_L1PRO mk_rk3328_l1pro.sh 设置打包 rk3328 l1pro 的脚本文件名
SCRIPT_S905 mk_s905_mxqpro+.sh 设置打包 s905 mxqpro+ 的脚本文件名
SCRIPT_S905D mk_s905d_n1.sh 设置打包 s905d n1 的脚本文件名
SCRIPT_S905X2 mk_s905x2_x96max.sh 设置打包 s905x2 x96max 的脚本文件名
SCRIPT_S905X3 mk_s905x3_multi.sh 设置打包 s905x3 multi 的脚本文件名
SCRIPT_S912 mk_s912_zyxq.sh 设置打包 s912 zyxq 的脚本文件名
SCRIPT_S922X mk_s922x_gtking.sh 设置打包 s922x gtking 的脚本文件名
SCRIPT_S922X_N2 mk_s922x_odroid-n2.sh 设置打包 s922x odroid-n2 的脚本文件名
SCRIPT_DIY mk_diy.sh 设置打包 diy 自定义脚本文件名
WHOAMI flippy 设置 make.env 中 WHOAMI 参数的值
OPENWRT_VER auto 设置 make.env 中 OPENWRT_VER 参数的值。默认 auto 将自动继承文件中的赋值，设置为其他参数时将替换为自定义参数。
SW_FLOWOFFLOAD 1 设置 make.env 中 SW_FLOWOFFLOAD 参数的值
SFE_FLOW 1 设置 make.env 中 SFE_FLOW 参数的值
HW_FLOWOFFLOAD 0 设置 make.env 中 HW_FLOWOFFLOAD 参数的值
ENABLE_WIFI_K504 1 设置 make.env 中 ENABLE_WIFI_K504 参数的值
ENABLE_WIFI_K510 1 设置 make.env 中 ENABLE_WIFI_K510 参数的值

输出参数说明

根据 github.com 的标准输出了 3 个变量，方便编译步骤后续使用。由于 github.com 最近修改了 fork 仓库的设置，默认关闭了 Workflow 的读写权限，所以上传到 Releases 需要给账户的个人中心添加 GITHUB_TOKEN ，并在你 fork 的仓库添加密钥 GH_TOKEN， 并启用仓库中的 Workflow 读写权限。

参数 默认值 说明
${{ env.PACKAGED_OUTPUTPATH }} /opt/openwrt_packit/output 打包后的固件所在文件夹的路径
${{ env.PACKAGED_OUTPUTDATE }} 2021.08.25.1058 打包日期
${{ env.PACKAGED_STATUS }} success / failure 打包状态。成功 / 失败

OpenWrt 固件个性化定制说明

此 Actions 仅提供 OpenWrt 打包服务，你需要自己编译 openwrt-armvirt-64-default-rootfs.tar.gz。编译方法可以参考 https://github.com/breakings/OpenWrt