使用 GitHub Actions 为 VShell 实施 CI 管道

介绍

本周,我深入研究了使用 github actions 设置持续集成 (ci) 管道,同时还扩展了我的项目 vshell 的单元测试套件。这个过程增强了我对 ci 原理、自动化测试以及帮助开发人员确保可靠代码交付的工具的理解。

什么是持续集成?

持续集成是一种开发实践,其中代码更改会自动测试并频繁集成到共享存储库中。通过利用 CI 管道,开发人员可以在开发周期的早期检测并解决问题,从而提高代码质量并降低集成风险。 CI/CD 管道使我们能够自动构建、测试和部署应用程序,从而加速开发并提高可靠性。

使用 GitHub Actions 设置 CI 管道

有许多可用的 CI 工具——Jenkins、CircleCI、TravisCI 和 GitLab CI 等——但本周,我专注于 GitHub Actions 来为我的应用程序实现 CI/CD。 GitHub Actions 直接在 GitHub 中提供集成、简单的设置,使其成为我的项目的绝佳选择。

为我的项目配置 GitHub 操作 为了设置 CI 管道,我导航到 GitHub 存储库的“操作”选项卡并选择 Node.js 模板,因为我的应用程序基于 JavaScript 并在 Node.js 上运行。这生成了一个定义 CI 管道行为的 .yml 配置文件。

Image description

理解 YAML 配置 对于 CI 新手来说,.yml 文件可能看起来令人生畏。以下是其工作原理的详细说明:

触发管道:管道设置为在向主分支发出推送或拉取请求时运行,使用 on 关键字定义这些触发器。

定义作业:配置包括触发 CI 管道时执行的一系列作业。这些作业指定 Ubuntu 操作系统构建环境,跨不同 Node.js 版本进行测试,并包含设置和执行运行时环境的步骤。最后,自动运行测试来验证代码。

我的经历

环境变量配置在我的初始管道设置期间,我遇到了与 GROQ_API_KEY 相关的错误,这对于某些测试至关重要并在我的本地 .env 文件中定义。虽然测试在本地顺利运行,但 GitHub Actions 无法访问该变量,导致运行失败。

解决方案:设置 GitHub 机密 为了解决此问题,我在 GitHub 存储库设置中为 API 密钥配置了一个机密变量。以下是修复的快速摘要:

  • 我导航到存储库的设置,并在 Settings > Secrets 下添加 GROQ_API_KEY 作为秘密。
  • 在 .yml 文件中,我添加了 env 关键字来指示管道检索此密钥,确保测试可以访问它,而无需在配置文件中硬编码敏感数据。

以上就是使用 GitHub Actions 为 VShell 实施 CI 管道的详细内容,更多请关注硕下网其它相关文章!