登录
推荐 文章 Go 技术 课程 下载 专题 AI
首页 >  文章 >  软件教程

GitHub Actions defaults.run 怎样统一设置工作目录

来源:17golang原创

时间:2026-11-17 23:32:21 152浏览 收藏

GitHub Actions 里如果每个 run 步骤都重复写 working-directory,工作流很快会变得难维护。更稳妥的做法是把公共目录放到 defaults.run.working-directory,再用 job 级或单步配置覆盖特殊任务。需要注意:这个默认值只影响 shell 的 run 步骤,不会改变 uses 步骤的行为,而且目标目录必须在运行前已经存在。

官方文档:https://docs.github.com/en/actions/how-tos/write-workflows/choose-what-workflows-do/set-default-values-for-jobs

要点速览
  • 工作流级默认目录写在 defaults.run,适合所有 job 共用的脚本目录。
  • job 级和 step 级的 working-directory 更具体,优先覆盖上层设置。
  • 先 checkout,再用 pwd、test -f 检查目录和关键文件,日志更容易定位。

先确认工作流文件和目录位置

在仓库页面依次打开“Code → .github/workflows → 目标 YAML 文件 → Edit this file”。假设脚本目录是仓库根目录下的 scripts,应先确认该目录已经提交,而不是只存在于本地电脑。Actions runner 检出仓库后,./scripts 才能作为相对路径使用。

如果工作流由多个 job 共用同一个脚本目录,直接使用工作流级默认值;如果某个 job 需要进入 backend,再在该 job 内覆盖,不要把所有步骤都改成绝对路径。

用 defaults.run 设置统一目录

在编辑器中定位到顶层 jobs 之前,按“YAML 文件 → 顶层 defaults → run → working-directory”填写配置。保留 actions/checkout,让仓库先落到 runner 的工作区,再运行脚本。

name: build

on:
  push:
    branches: [main]

# 顶层默认值覆盖所有 job 的 run 步骤
defaults:
  run:
    working-directory: ./scripts

jobs:
  check:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v6
      - name: Run checks
        # 这里会在仓库的 scripts 目录中执行
        run: ./check.sh

这里的 uses: actions/checkout@v6 不是 shell 命令,不会因为 defaults.run 而切换目录。真正执行 ./check.sh 的 run 步骤才会使用 ./scripts。保存后点击“Commit changes”,再从“Actions → build → 最新运行”进入执行记录。

GitHub Actions defaults.run 工作流级 working-directory 与 scripts 目录关系的原创说明图
图1:工作流级默认目录的原创操作示意图,不是 GitHub 截图。

用 job 和 step 级配置覆盖默认值

当一个工作流同时处理前端和后端目录时,配置路径是“jobs → job_id → defaults → run → working-directory”。它只影响当前 job 的所有 run 步骤;某一步还可以在“jobs → job_id → steps → run → working-directory”中单独指定目录。

jobs:
  backend:
    runs-on: ubuntu-latest
    defaults:
      run:
        # job 级设置覆盖 workflow 级 ./scripts
        working-directory: ./backend
    steps:
      - uses: actions/checkout@v6
      - name: Test backend
        run: go test ./...
      - name: Read generated tools
        # step 级设置只覆盖当前这一步
        working-directory: ./tools
        run: ./inspect.sh

优先级可以记成“单步 > job > workflow”。配置时不要把表达式放进 defaults.run 的关键字里;官方语法说明该默认配置不接受 contexts 或 expressions。若目录来自变量,改用具体 run 步骤的 working-directory,并在脚本中明确处理输入。

GitHub Actions workflow job step 三层 working-directory 覆盖与日志核对的原创说明图
图2:目录覆盖优先级与结果核对的原创结果示意图,不是运行截图。

从 Actions 日志核对真正生效的目录

配置提交后打开“Actions → build → 最新运行 → check → Run checks”。不要只看绿色勾选,给关键步骤加一个短暂的检查更可靠:

- name: Verify working directory
  # 先输出当前目录,再检查脚本文件是否存在
  run: |
    pwd
    test -f ./check.sh

如果日志中的路径以 .../scripts 结尾,且 test 返回成功,说明默认目录生效;若出现“找不到文件”,先检查仓库目录大小写、checkout 是否在前面,以及 job 级设置是否覆盖了预期目录。目录不存在时不要用 mkdir -p 掩盖配置错误,先修正仓库结构或路径。

常见问题

defaults.run 会影响 uses 步骤吗?

不会。它服务于 shell 的 run 步骤;Action 的执行位置和输入仍由该 Action 自己决定。

job 级目录为什么没有按 workflow 级配置执行?

更具体的 job 级 defaults.run.working-directory 会覆盖 workflow 级值,检查该 job 是否写了自己的默认目录。

相对目录什么时候检查最合适?

在 checkout 之后、业务命令之前,用 pwd 和 test -f 检查;这样日志能区分目录配置问题和脚本本身的失败。

这套配置的核心不是把路径写得更长,而是让默认范围、覆盖范围和验收日志一一对应:公共目录放 workflow,特殊 job 下沉到 job,单个例外只写在 step。

声明:本文转载于:17golang原创 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>