CI/CD / 知识点

GitHub Actions 工作流语法速查

工作流基础

使用顶层 name 为工作流设置显示名称,便于 Actions 列表、运行记录和排障时区分多个流水线;未设置时 GitHub 可根据文件名显示默认名称。

name:配置工作流名称

当仓库中存在多个工作流、需要在 Actions 页面快速区分构建、测试和部署流水线时,查看或设置顶层 name。它只负责工作流的显示名称,不决定触发条件或单次运行名称。

值与含义

写法 含义 建议动作
name: CI 将工作流显示名称设为 CI 为长期维护的工作流使用稳定、易检索的名称
未设置 name GitHub 使用工作流文件路径标识工作流 多个文件用途接近时建议显式设置
run-name 设置单次 workflow run 的显示名称 不要把它与顶层 name 混用

name 位于工作流 YAML 顶层,与 on、jobs 同级。

快速确认

将下面内容保存为 .github/workflows/manual-check.yml 并提交到仓库默认分支:

yaml
name: Manual Check

on:
  workflow_dispatch:

jobs:
  verify:
    runs-on: ubuntu-latest
    steps:
      - name: Print workflow name
        run: echo "workflow is running"

预期结果:打开仓库的 Actions 页面后,可以看到名为 Manual Check 的工作流;手动运行后,verify 作业成功,步骤日志包含:

text
workflow is running

判读与常见误用

如果 Actions 页面显示的工作流名称不符合预期,先确认 name 是否位于 YAML 顶层,而不是写进某个 job 或 step。若目标是让每次运行显示分支、部署环境或触发人,应使用 run-name,而不是动态修改 name。

适用范围

适用于存放在 .github/workflows 下的 GitHub Actions 工作流 YAML。GitHub 当前文档规定:省略 name 时,界面使用工作流文件相对仓库根目录的路径作为名称。GitHub Docs

权限与安全

作业与执行控制

步骤与 Action

目录与阅读设置

记录一个想法

GitHub Actions 工作流语法速查

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通