如何验证GitHub Actions工作流YAML中引用的env变量是否存在？

方法1：用yq+grep组合命令单文件检查 #

你之前用yq没效果大概率是语法不对，针对yq v4（目前主流版本），可以结合grep提取所有env引用，再和env块定义的变量对比：

1. 提取当前工作流文件里env块定义的所有变量，输出到临时文件：

yq '.env | keys' .github/workflows/your-workflow.yml | sed 's/- //' | sort > env-defined.txt

2. 提取文件中所有${{ env.some_variable }}格式的引用，去重后输出到临时文件：

grep -oP '\${{ env\.(\w+) }}' .github/workflows/your-workflow.yml | cut -d '.' -f2 | cut -d '}' -f1 | sort | uniq > env-referenced.txt

3. 对比两个文件，找出引用了但没定义的变量：

comm -23 env-referenced.txt env-defined.txt

执行完会直接列出所有未在env块中定义的env变量引用。

方法2：批量检查所有工作流的shell脚本 #

如果有大量工作流文件，写个shell脚本一键遍历检查更高效：

#!/bin/bash

WORKFLOW_DIR=".github/workflows"

for file in "$WORKFLOW_DIR"/*.yml "$WORKFLOW_DIR"/*.yaml; do
    echo "检查文件: $file"
    # 提取env块变量，处理文件无env块的情况
    defined_vars=$(yq '.env | keys' "$file" 2>/dev/null | sed 's/- //' | grep -v '^null$')
    if [ -z "$defined_vars" ]; then
        echo "  该文件没有定义env块"
    else
        echo "$defined_vars" | sort > temp-defined.txt
        # 提取所有env引用
        referenced_vars=$(grep -oP '\${{ env\.(\w+) }}' "$file" | cut -d '.' -f2 | cut -d '}' -f1 | sort | uniq)
        if [ -z "$referenced_vars" ]; then
            echo "  该文件没有引用env变量"
        else
            echo "$referenced_vars" > temp-referenced.txt
            # 找出未定义的变量
            missing=$(comm -23 temp-referenced.txt temp-defined.txt)
            if [ -n "$missing" ]; then
                echo "  未定义的env变量引用:"
                echo "$missing"
            else
                echo "  所有env引用都已在env块中定义"
            fi
        fi
    fi
    echo "---"
done

# 清理临时文件
rm -f temp-defined.txt temp-referenced.txt

把脚本保存为check-env.sh，赋予执行权限chmod +x check-env.sh，直接运行就能批量检查所有工作流。

方法3：Python脚本深度解析（更精准） #

如果工作流结构复杂（比如job级、step级的env引用），shell命令可能漏检，用Python脚本可以更全面地遍历所有字段：

import yaml
import re
import os

WORKFLOW_DIR = ".github/workflows"
# 匹配env变量引用的正则
env_ref_pattern = re.compile(r'\${{ env\.(\w+) }}')

for filename in os.listdir(WORKFLOW_DIR):
    if filename.endswith(('.yml', '.yaml')):
        file_path = os.path.join(WORKFLOW_DIR, filename)
        print(f"检查文件: {file_path}")
        with open(file_path, 'r') as f:
            try:
                workflow = yaml.safe_load(f)
            except yaml.YAMLError as e:
                print(f"  解析出错: {e}")
                continue
        
        # 获取顶层定义的env变量
        defined_env = workflow.get('env', {})
        defined_vars = set(defined_env.keys()) if isinstance(defined_env, dict) else set()
        
        # 遍历所有可能出现env引用的地方：顶层env、job级env、step的run/env字段
        referenced_vars = set()
        # 检查顶层env里的引用
        if 'env' in workflow:
            for val in workflow['env'].values():
                matches = env_ref_pattern.findall(str(val))
                referenced_vars.update(matches)
        # 检查jobs下的内容
        if 'jobs' in workflow:
            for job in workflow['jobs'].values():
                # 检查job级env的引用
                if 'env' in job:
                    for val in job['env'].values():
                        matches = env_ref_pattern.findall(str(val))
                        referenced_vars.update(matches)
                # 检查每个step
                if 'steps' in job:
                    for step in job['steps']:
                        # 检查step的run命令和step级env
                        for key in ['run', 'env']:
                            if key in step:
                                if isinstance(step[key], dict):
                                    for val in step[key].values():
                                        matches = env_ref_pattern.findall(str(val))
                                        referenced_vars.update(matches)
                                else:
                                    matches = env_ref_pattern.findall(str(step[key]))
                                    referenced_vars.update(matches)
        
        # 对比找出未定义的变量
        missing_vars = referenced_vars - defined_vars
        if missing_vars:
            print(f"  未定义的env变量引用: {', '.join(missing_vars)}")
        else:
            print(f"  所有env引用都已定义")
        print("---")

使用前先安装依赖：pip install pyyaml，运行脚本即可完成全量检查。

内容的提问来源于stack exchange，提问作者Underoos