Github Action on rustWood

Github Action实践练习2_缓存、制品与邮件通知

Tue, 07 Apr 2026 19:20:38 +0800

问题描述

在 GitHub Actions 里，不同的 Job 默认运行在完全不同的、干净的虚拟机上。这就带来了两个致命问题：

慢（需要 Cache）：Job1 用 pip install 下载了 100MB 的依赖，跑完销毁了。Job2 如果也要跑 Python，还得重新下载 100MB。
看不见（需要 Artifact）：Job1 编译生成了一个 report.txt 文件，但是因为磁盘不共享，所有Job2找不到这个文件！。

解决方案：

Cache（缓存）：把下载好的包存到 GitHub 的缓存服务器里，下次如果 requirements.txt 没变，直接解压，10秒搞定。
Artifact（制品）：把 Job1 生成的文件打包上传到 GitHub 服务器，Job2 再下载下来解压。

解决实践

为了解决上面的问题，写一条包含两个 Job 的流水线：

Job 1 (构建与测试)：安装 Python 依赖（用 Cache 加速），运行代码生成一个 result.txt 文件（用 Artifact 保存）。
Job 2 (通知)：等 Job 1 成功后，把 result.txt 下载下来，读取内容，调用第三方action发送邮件。

具体操作

在仓库目录下创建build.py（模拟生成报告）和requirement.txt（测试缓存）。

requirement.txt内容如下：

1
2

requests
pytest

build.py内容如下：

import time
time.sleep(2) # 模拟耗时代码
with open("result.txt", "w", encoding="utf-8") as f:
    f.write("Python项目构建成功！\n测试用例全部通过")
print("构建完成，已生成 result.txt")

在.github/workflows下创建cache-notify.yaml工作流文件：

补充：secrets.MAIL_USERNAME是需要自己在对应的仓库添加的密钥。

添加方法为：打开仓库->Settings->Secrets and variables->Actions->New repository secret

name: Cache & Artifact & Notify

on:
  push:
    branches:
      - main

jobs:
  # ==========================================
  # Job 1: 构建（负责缓存和生成制品）
  # ==========================================
  build:
    runs-on: ubuntu-24.04
    env:
      BRANCH: ${{ github.ref_name }}
      
    steps:
      - name: Checkout code
        uses: actions/checkout@v6

      # 1. Cache 缓存
      # setup-python 官方自带了 cache 参数，比手写 actions/cache 更简单！
      # 它会根据 requirements.txt 的哈希值来判断是否需要重新下载
      - name: Setup Python with Cache
        uses: actions/setup-python@v6
        with:
          python-version: '3.13'
          cache: 'pip'           # <- 神奇的一行：开启 pip 缓存

      - name: Install dependencies
        run: pip install -r requirements.txt

      - name: Run build script
        run: python build.py

      # 2. Artifact 制品传递
      # 把 Job1 生成的 result.txt 上传
      - name: Upload result file
        uses: actions/upload-artifact@v7
        with:
          name: build-report      # 制品的名字
          path: result.txt        # 要上传的文件路径
          retention-days: 1       # 保留1天（避免占用 GitHub 存储空间）

  # ==========================================
  # Job 2: 通知（负责接收制品并调用第三方Action）
  # ==========================================
  notify:
    runs-on: ubuntu-24.04
    # 3. Job 依赖
    # 必须等 build 这个 job 成功后，notify 才会跑
    needs: build
    
    steps:
      # 4. 下载制品
      # 把 Job1 上传的文件下载到当前机器
      - name: Download result file
        uses: actions/download-artifact@v8
        with:
          name: build-report

      # 读取文件内容，赋值给环境变量，供下一步使用
      - name: Read result
        run: |
            echo "MSG_CONTENT<<EOF" >> $GITHUB_ENV
            cat result.txt >> $GITHUB_ENV
            printf "\nEOF\n" >> $GITHUB_ENV            

      - name: Send email notification
        uses: dawidd6/action-send-mail@v16
        with:
          # 必填：邮件服务器
          server_address: smtp.qq.com      # 例如 QQ 邮箱；163 用 smtp.163.com；Gmail 用 smtp.gmail.com
          server_port: 465                  # QQ/163 用 465（SSL）；Gmail 也推荐 465
          secure: true

          # 必填：SMTP 账号 & 密码（推荐用 Secrets）
          username: ${{ secrets.MAIL_USERNAME }}   # 完整邮箱地址
          password: ${{ secrets.MAIL_PASSWORD }}   # 邮箱“授权码”/应用密码，不是登录密码

          # 必填：收件人（可以是多个，逗号分隔）
          to: ${{ secrets.NOTIFY_EMAIL }}          # 接收通知的邮箱

          # 必填：发件人（建议和SMTP账号一致）
          from: GitHub Actions <${{ secrets.MAIL_USERNAME }}>

          # 必填：邮件主题
          subject: "【GitHub 通知】${{ github.repository }}${{ github.ref_name }} 构建结果"

          # 可选：正文（支持多行）
          body: |
            仓库：${{ github.repository }}
            分支：${{ github.ref_name }}
            触发人：${{ github.actor }}
            提交信息：${{ github.event.head_commit.message }}

            构建报告：
            ${{ env.MSG_CONTENT }}

Github Action实践练习1_创建Action并使用if判断

Fri, 03 Apr 2026 17:29:34 +0800

创建仓库与分支

在GitHub上创建仓库

本地文件夹上传到github仓库

git init
git commit -m "first commit"
git branch -M main
git remote add origin https://github.com/rusthx/GithubActionTest.git
git push -u origin main

创建并切换分支

1
2

git switch -c dev
git switch main

将当前分支推送到 origin，并设置上游关系

1
2

git switch dev
git push -u origin dev

创建workflows

在文件夹下创建test.py，填入print("hello world")。

在文件夹下创建文件.github\workflows\first.yaml，注意是.github不是github文件夹。

name: fristtest

on:
  push:
    
jobs:
  test:
    runs-on: ubuntu-24.04
    if: github.ref == 'refs.heads/main'
    steps:
      - name: Checkout
        uses: actions/checkout@v6

      - name: Setup Python
        uses: actions/setup-python@v6
        with:
          python-version: '3.13' 
        
      - name: Run test.py
        run: python test.py

这个工作流的意思是判断上传分支是main分支才执行，其他分支跳过。job有3个steps，运行在ubuntu-24.04上。

复用checkout action，作用是创建工作流容器，拉取仓库里最新的代码
复用setup-python action，作用是在容器里安装python3.13
运行test.py，会打印hello world

提交更改到GitHub上。

1
2
3

git add .
git commit -m 'test.py练习'
git push

运行成功截图：

切换分支，测试提交

切换到dev分支，修改test.py，填入print("hello dev")，提交。

git switch dev
# 修改test.py
git add .
git commit -m 'dev test,练习if判断'
git push

dev分支提交的更改被成功跳过。

分支练习

写一个流水线，当push到main分支时打印“准备发布”，当push到其他分支时打印“仅测试”，并输出当前分支名和提交者姓名。

github.ref 完整引用路径，如 refs/heads/main、refs/heads/dev
github.ref_name 纯分支名，如 main、dev
github.actor 触发这次 Action 的 GitHub 用户名

name: branch-check

on:
    push:

jobs:
    check:
        runs-on: ubuntu-24.04
        env:
          BRANCH_NAME: ${{ github.ref_name }}
          ACTOR_NAME: ${{ github.actor }}
        steps:
          - name: Checkout
            uses: actions/checkout@v6

          - name: Branch print
            run: |
              if [ "$BRANCH_NAME" == "main" ]; then
                  echo "准备发布"
              else
                  echo "仅测试"
              fi              

          - name: Info print
            run: echo "分支:BRANCH_NAME,提交者:$ACTOR_NAME pushed this change"

刚刚在dev分支做了修改并提交到了GitHub仓库，然后我在GitHub仓库里merge了更改。 merge后远程仓库main分支的代码和本地的不同，需要先拉取远程仓库代码到本地再做修改，然后再推到远程仓库。

git pull origin main
# 对最新的代码进行修改

# 提交修改到远程仓库
git add .
git commit -m "main分支做了一些修改"
git push origin main

本地main分支修改后，再推到远程仓库会报错，解决步骤如下：

# 保存本地修改
git add .
git commit -m "保存本地改动"
# 拉取远程仓库代码
git pull origin main
# 对比差异，更改代码(手工对比删除不要的代码)


# 推送代码
git add .
git commit -m "解决 main 分支合并冲突"
git push origin main