功夫预编译二进制文件发布管理

目标 - Requirements

做为一个跨平台项目，功夫有很多组件涉及平台相关的二进制文件，需要针对每个操作系统单独编译及发布。随着项目复杂度增加，编译时间可能会增长到数分钟甚至数十分钟。在使用这些组件作为依赖时，如果可以直接下载预先编译好的二进制文件，就可以避免在本地配置编译环境以及超长编译时间带来的麻烦。具体而言，一个完善的预编译二进制文件的发布管理流程有以下几个目标：

文件信息包含版本及操作系统信息，使得用户根据使用环境可以精确定位具体的下载路径。
预编译文件的发布应配合功夫版本控制流程，当且仅当对应版本完成发布流程时才会同时发布相应的预编译文件。发布的预编译文件应和对应版本的代码严格一一对应。
预编译文件的下载应考虑 CI 服务器和开发者的桌面环境，针对机器所在位置（**境内或海外）做出适配，以避免网络问题导致无法下载。

规则 - Rules

出于以上需求，我们结合使用 GitHub Actions、AWS 国际和**区的服务器为预编译文件提供上传及下载服务。在执行编译环节的 GitHub Actions 运行期间，需要将各操作系统环境下产生的二进制文件通过 GitHub 的上传 Artifacts 功能上传到 GitHub 的文件中转区。编译结束后，在调用本 action 之前，需要通过 GitHub 的下载 Artifacts 功能下载到 Action Runner 的本地，并通过 github-artifacts 参数设定具体的路径。

为配合功夫版本控制流程，需支持将预编译文件上传到待发布状态的缓存区，待相关 Pull Request 审核通过之后才正式发布到公共下载区。

用法 - Usage in GitHub Workflow YML

输入参数 - Inputs

token 用于给对应 Pull Request 添加评论信息，建议使用 secrets.GITHUB_TOKEN
aws-proxy 如需使用针对海内外的专有网络加速服务，可通过此参数设置相关服务，需符合 hosts 文件格式。相关设置会写入到 /etc/hosts。使用此参数时需要同时使用具备对 /etc/hosts 文件有写入权限的 docker 镜像。
artifacts-path 在编译相关的 GitHub Action 中上传的文件所对应的路径，填写后将触发从该路径到 bucket-staging 的上传。上传文件的路径规则为

"**/build/stage/${product-name}/v${version.major}/v${version}/*.*";

其中 ${product-name} 对应相关产品名称例如 kungfu-core，${version.major} 对应主版本号，${version} 对应具体的版本号。路径信息 ${product-name}/v${version.major}/v${version} 最终会作为文件在 bucket-release 的绝对路径。若上传中文件路径不包含 build/stage 部分则不会触发上传操作。

bucket-staging 用于待发布状态的 S3 bucket，当提供 artifacts-path 参数时其为上传目的地，当提供 bucket-release 参数时其为上传源。在每次发布流程中，会在这个 bucket 中创建一个 ${repo}/v${version} 的目录用于存储指定 repo 的对应版本的预编译文件，流程开启前和结束后都会清空该路径。上传成功后若未将 no-comment 参数设置为 "true" 则会添加一个评论（Comment）提供所有文件的下载 URL（需将相应 Bucket 运行其中的 Object 可以接受 Public Access）。
bucket-release 用于发布预编译文件的 S3 bucket，填写后将触发从 bucket-staging 到 bucket-release 的同步（s3 sync）操作。
no-comment 若设置为 "true" 则不会添加评论信息，默认为 "false"。

输出参数 - Outputs

无

示例 - Examples

准备待发布 - Prepare for Publish

on:
  pull_request:
    types: [opened, reopened, synchronize]
    branches:
      - alpha/*/*
      - release/*/*
      - main

jobs:
  prepare:
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Build
        run: yarn build

      - name: Configure AWS Crendentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: us-east-1

      - name: Publish Prebuilt to AWS
        uses: kungfu-trader/action-publish-prebuilt@v2
        with:
          artifacts-path: "github-artifacts"
          bucket-staging: "user-bucket-staging"

发布 - Publish

on:
  pull_request:
    types: [closed]
    branches:
      - alpha/*/*
      - release/*/*
      - main

jobs:
  publish:
    if: ${{ github.event.pull_request.merged }}
    runs-on: ubuntu-latest
    steps:
      - name: Checkout
        uses: actions/checkout@v2

      - name: Configure AWS Crendentials
        uses: aws-actions/configure-aws-credentials@v1
        with:
          aws-access-key-id: ${{ secrets.AWS_ACCESS_KEY_ID }}
          aws-secret-access-key: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
          aws-region: us-east-1

      - name: Publish Prebuilt to AWS
        uses: kungfu-trader/action-publish-prebuilt@v2
        with:
          bucket-staging: "user-bucket-staging"
          bucket-release: "user-bucket-release"

kungfu-trader / action-publish-prebuilt