CI/CD / 系统课时

创建第一份工作流文件

创建第一份工作流文件

这一篇直接创建一份最小可运行的 GitHub Actions 工作流:把 YAML 文件放入 .github/workflows/,让它在推送到 main 时启动 Ubuntu Runner,并执行一条 Shell 命令。完成后,你将能在 Actions 页面看到运行记录并核对日志。

学习目标

  • 能在正确目录创建合法的 GitHub Actions 工作流文件
  • 理解 name、on、jobs、runs-on 和 steps 的最小职责
  • 能通过一次提交验证工作流是否真正执行成功

创建工作流文件

在仓库根目录创建 .github/workflows/hello.yml。.github/workflows/ 是 GitHub 识别工作流文件的约定目录,文件可以使用 .yml 或 .yaml 扩展名。

最小工作流如下:

yaml
name: Hello Actions

on:
  push:
    branches:
      - main

jobs:
  hello:
    runs-on: ubuntu-latest
    steps:
      - name: Print message
        run: echo "Hello from GitHub Actions"

这是完整的工作流配置文件,不需要控制台输出。保存后可先检查 YAML 缩进,再提交到仓库。name 是 Actions 页面显示的工作流名称;on 指定触发事件;jobs 定义任务;runs-on 选择 Runner 类型;steps 则描述 Job 内依次执行的步骤。

提交并触发第一次运行

工作流只有进入 GitHub 仓库后才能由 GitHub Actions 使用。确认当前分支为 main 后,提交文件并推送:

bash
git add .github/workflows/hello.yml
git commit -m "add first GitHub Actions workflow"
git push origin main

预期输出

text
To <REPOSITORY_URL>
   <OLD_COMMIT>..<NEW_COMMIT>  main -> main

仓库地址和提交哈希属于动态值,实际输出会不同。由于这次推送同时把工作流文件加入了 main,并且配置监听 main 的 push,GitHub 可以据此创建第一次运行。

在 Actions 页面验证结果

打开仓库的 Actions 页面,选择 Hello Actions,进入刚刚产生的 Workflow Run,再展开 hello Job 和 Print message Step。成功执行时,步骤日志中应出现配置里的文本。

预期结果

text
Hello from GitHub Actions

如果 Workflow Run 和 Job 均显示成功,并且日志包含这行文本,就说明触发条件、Runner 分配和 Shell Step 三个关键环节已经全部跑通。界面中的运行编号、时间和 Runner 版本属于动态信息,不需要与其他人的截图一致。

看不到运行时怎么检查

首先确认文件路径确实是 .github/workflows/hello.yml,而不是放在仓库根目录或类似 .github/workflow/ 的错误目录。随后检查文件已经被提交并推送,而不是只存在于本地工作区。

再检查实际推送的分支。当前示例只监听 main,如果仓库默认分支叫 master、develop 或其他名称,推送到那些分支不会匹配当前过滤条件。可以用下面的命令确认当前分支:

bash
git branch --show-current

预期输出

text
main

如果输出不是 main,应根据仓库实际分支调整工作流的 branches 配置,或者将提交推送到 main。不要为了让工作流“有反应”而直接删除所有过滤条件;先确认事件和分支是否符合你真正希望的触发范围。

当页面已经出现运行记录但状态失败时,说明触发阶段已经通过,应展开失败的 Job 和 Step 阅读日志,而不是继续修改 on。第一条流水线的验收标准很简单:工作流被正确触发、hello Job 成功结束,并且日志准确打印 Hello from GitHub Actions。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

创建第一份工作流文件

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

登录哪都通