nx-set-shas：智能设定 Git SHA 值，优化 CI 流程

nx-set-shas：智能设定 Git SHA 值，优化 CI 流程

nx-set-shas :sparkles: A Github Action which sets the base and head SHAs required for `nx affected` commands in CI 项目地址: https://gitcode.com/gh_mirrors/nx/nx-set-shas

项目介绍

nx-set-shas 是一个 GitHub Action，旨在为 Nx（一个智能、可扩展的构建框架）的 affected 命令在持续集成（CI）过程中设定必要的基（base）和头（head）SHA 值。通过使用此 Action，开发者可以精确地确定哪些项目受到了特定代码变更的影响，从而只对这些项目执行构建、测试或部署等操作。

项目技术分析

nx-set-shas 利用 GitHub API 来追踪工作流的成功执行，并根据这些成功的工作流设置 SHA 值。它允许开发者在 CI 系统中，通过比较不同提交之间的差异，自动确定需要构建和部署的项目。以下是该项目的技术亮点：

• 智能 SHA 值设定：自动查找上一个成功的 CI 运行对应的提交 SHA 值，确保 CI 系统不会因为连续失败的提交而遗漏任何变更。
• 灵活配置：支持自定义远程名称、分支名称、工作流 ID 等参数，以适应不同项目的需求。
• 环境变量支持：可以将 SHA 值设置为环境变量，方便后续步骤使用。

项目及技术应用场景

在当代的软件开发生命周期中，持续集成和持续部署（CI/CD）是至关重要的环节。 nx-set-shas 可以在以下场景中发挥作用：

• PR 流程优化：当一个新的 PR 被创建时，nx-set-shas 可以确定 PR 分支的来源 SHA 和当前 SHA，确保整个 PR 的变更都能得到测试。
• 持续部署：在代码被合并到主分支后，nx-set-shas 可以帮助确定自上次成功部署以来发生的所有变更，从而只对受影响的项目执行部署。
• 自定义工作流：对于复杂的项目结构，nx-set-shas 可以帮助开发者自定义 CI 流程，提高构建和部署的效率。

项目特点

nx-set-shas 的特点如下：

• 自动查找 SHA 值：自动查找并设定基和头 SHA 值，无需手动干预。
• 支持自定义配置：提供多种配置选项，包括远程名称、分支名称、SHA 值设定等。
• 兼容自托管运行器：支持使用自定义的运行器，满足不同项目的需求。
• 易于集成：作为 GitHub Action，可以轻松集成到现有的 GitHub 工作流中。
• 灵活的错误处理：提供错误处理选项，允许在找不到成功工作流时自定义行为。

nx-set-shas 通过优化 SHA 值的设定过程，帮助开发者简化 CI 流程，提高开发效率和部署质量。在快节奏的软件开发环境中，这样的工具对于保证代码质量和加速迭代过程至关重要。

---

以下是具体的使用方法和配置指南，帮助开发者快速上手：

使用方法

1. 添加 Action：在 .github/workflows/ci.yml 文件中添加 nx-set-shas Action。

jobs:
  myjob:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
        with:
          fetch-depth: 0
      - uses: nrwl/nx-set-shas@v4

2. 配置参数：根据项目需求配置相关参数，如分支名称、远程名称等。

- uses: nrwl/nx-set-shas@v4
  with:
    main-branch-name: 'main'
    remote: 'origin'

3. 使用环境变量：在后续步骤中，可以通过环境变量访问已设置的 SHA 值。

- run: |
    echo "BASE: ${{ env.NX_BASE }}"
    echo "HEAD: ${{ env.NX_HEAD }}"

配置选项

nx-set-shas 提供了丰富的配置选项，以满足不同项目的需求：

• gh-token：GitHub 令牌，用于执行 Git 操作。
• main-branch-name：主分支的名称，默认为 main。
• remote：远程仓库的名称，默认为 origin。
• set-environment-variables-for-job：是否将 SHA 值设置为环境变量，默认为 true。
• error-on-no-successful-workflow：如果找不到成功的工作流，是否报错退出，默认为 false。
• fallback-sha：当找不到成功工作流时的后备 SHA 值。
• last-successful-event：查找最后成功提交时对应的事件类型，默认为 push。
• working-directory：仓库代码所在的路径，默认为 .。
• workflow-id：要检查成功运行的工作流的 ID 或文件名。

通过合理配置这些选项，开发者可以确保 nx-set-shas Action 能够适应各种复杂的 CI/CD 场景。

总结而言，nx-set-shas 是一个强大且灵活的 GitHub Action，适用于需要对 CI 流程进行优化的开发者。通过自动设定 SHA 值，它不仅简化了构建和部署流程，还提高了整个软件开发过程的效率和质量。

nx-set-shas :sparkles: A Github Action which sets the base and head SHAs required for `nx affected` commands in CI 项目地址: https://gitcode.com/gh_mirrors/nx/nx-set-shas