如何使用 Github 操作自动化您的存储库构建

x33g5p2x  于2022-02-14 转载在 其他  
字(1.9k)|赞(0)|评价(0)|浏览(155)

如果您厌倦了手动构建和发布应用程序,那么可能是时候设置 CI/CD 管道了。Github Actions 使大多数项目的这个过程变得简单和免费,并且可以通过自动化应用程序的构建过程来节省您的时间。

什么是行动?

Github Actions 是在云中运行的任务。它们可以使用 YAML 配置文件进行设置,并根据您帐户中发生的事情触发。这通常类似于“将新提交推送到主分支”,但实际上可以为许多不同的事件设置操作,包括新问题或发生时,甚至按计划作为 cron 作业。

在这种情况下,我们想设置一个自动构建。每当对存储库进行更改时,通常都会运行此过程。您可以根据需要进行设置 - 通常在master orrelease 分支上运行它,但您也可以在 dev 和 feature 分支上运行构建。

大多数构建过程也将涉及测试,Github Actions 也可以这样做。这有助于捕获导致构建失败的提交。您可能也不想部署失败的构建,因此在所有情况下预先运行测试都是有益的。

使用 Github Actions,您还可以自动化部署的发布部分。如果您有一个总是从其更新release 的master 分支,则可以将该分支视为您的部署源。您的服务器将从 Github Action 的输出下载二进制文件并更新您的代码。如果您使用 NPM、Maven 或 Docker Hub 之类的包管理器或注册表,这将变得更加容易——更新可以直接推送到注册表并在需要时拉取。

设置自动构建

Github Actions 使用基于 YAML 的配置系统。您需要定义两个基本的东西——动作何时触发,以及一旦触发将采取什么步骤。
您的确切配置将非常广泛地取决于您为应用程序使用的语言、框架和构建系统。不过,一般过程非常相似,对于此示例,我们将使用 Gradle 构建工具为基于 Java 的应用程序设置构建。

前往您的存储库并单击“操作”。Github 足够聪明,可以识别你的 repo 包含的应用程序类型,在这里它推荐了一些构建 Java 的不同操作。

单击“Java with Gradle”会打开 YAML 文件的 Github 编辑器,该编辑器预先配置了 Java 构建。这会在每次推送到 master 和每次 pull request 到 master 时运行。您也可以将其更改为在其他分支上运行,或者为开发/功能分支设置不同的操作。

您可以在此处编辑任何变量,完成后单击右侧的“提交”。如果您将构建设置为在推送时运行,则提交将触发构建。

您可以在“操作”选项卡下找到正在进行的工作流运行。

对失败的构建进行故障排除

当然,这并不总是那么容易——在现实世界中,构建环境可能非常脆弱,并且可能由于多种原因而失败。Github 为这个存储库提供的示例操作并没有使其通过启动:它甚至无法找到gradlew 运行构建。

一个奇怪的错误考虑到应该可以开箱即用,但快速搜索问题表明我们应该使用正确的 gradle-build-action 手动配置版本和参数。

要编辑您的操作配置,请转到您的操作并单击.yml 工作流名称下的文件以调出编辑器。

然后,您可以根据需要对其进行修补,然后再次提交。提交更改build.yml 算作对 的提交master,因此它将再次触发操作。

这一次,它可以正常工作,但由于一个小错误而再次失败——这个存储库需要 Gradle 7.1,而不是 6.5。无论您使用什么构建管道,您都需要解决所有这些问题,以使其与您在机器上手动执行的构建完美匹配。

使用您的构建工件

一旦所有这些都整理好,我们终于可以看到成功的绿色复选标记。

除了,它不是一个真正有用的构建——构建工件在哪里?默认情况下,此操作仅构建 repo,并且不提供任何输出项。

- name: capture build artifacts
uses: actions/upload-artifact@v2
with:
name: Artifacts
path: build/libs/

再次运行构建会正确上传工件。

如果您想让这些自动下载,您需要更改在 Github 上创建发布标签时运行的操作,然后使用您的令牌(作为环境变量传递)发布到 Github 包。

on:
  release:
    types: [created]

...

- name: Publish to GitHub Packages
      uses: gradle/gradle-build-action@4137be6a8bf7d7133955359dbd952c0ca73b1021
      with:
        arguments: publish
      env:
        USERNAME: ${{ github.actor }}
        TOKEN: ${{ secrets.GITHUB_TOKEN }}

相关文章