在GitHub Actions中配置Cypress测试环境变量遇未定义问题求助

问题详情 #

我在GitHub Actions中配置Cypress测试环境变量时遇到异常情况：

• 已按照Cypress文档要求，给所有环境变量添加CYPRESS_前缀
• 未在项目代码中使用的CYPRESS_TEST_VARIABLE、CYPRESS_ANOTHER_TEST_VARIABLE能正常传递
• 项目代码中依赖的PROJECT_ID（对应配置的CYPRESS_PROJECT_ID）却始终显示未定义

GitHub Actions的YAML配置：

name: Run cypress tests

on:
  pull_request:
    branches:
      - main
  workflow_dispatch:

jobs:
  tests:
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v3

      - name: Cypress run
        uses: cypress-io/github-action@v5
        env:
          CYPRESS_TEST_VARIABLE: 200
          CYPRESS_ANOTHER_TEST_VARIABLE: prsnlmgr-713a4
          CYPRESS_PROJECT_ID: prsnlmgr
        with:
          start: npm start
          wait-on: "http://localhost:3000" # Waits for above
          record: false
          parallel: false # Runs test in parallel using settings above

本地测试时，我通过未提交到仓库的cypress.env.json配置变量，运行完全正常：

{
  "TEST_UID": "{{value}}",
  "FIREBASE_PROJECT_ID": "{{value}}",
  "GCLOUD_PROJECT": "./serviceAccount.json",
  "TEST_ACCOUNT_EMAIL": "{{value}}",
  "TEST_ACCOUNT_PASSWORD": "{{value}}",
  "FIREBASE_API_KEY": "{{value}}",
  "PROJECT_ID": "{{value}}",
  "FIREBASE_APP_ID": "{{value}}"
}

怀疑是命名冲突导致PROJECT_ID这类项目依赖变量无法正常传递。

可能的解决方案 #

1. 规避Cypress内置变量冲突 #

PROJECT_ID是Cypress Dashboard录制功能的内置配置项，当你通过CYPRESS_PROJECT_ID设置时，会被Cypress自身的配置逻辑优先处理，导致无法注入到自定义环境变量中。

解决方法：修改变量名，比如改为CYPRESS_APP_PROJECT_ID，然后在代码中通过Cypress.env('APP_PROJECT_ID')读取。

2. 显式控制变量注入逻辑 #

绕过Cypress自动转换前缀的逻辑，直接在配置中手动注入变量：

• 修改GitHub Actions的env配置，直接传递未加前缀的变量：

- name: Cypress run
  uses: cypress-io/github-action@v5
  env:
    PROJECT_ID: prsnlmgr
    CYPRESS_TEST_VARIABLE: 200
    CYPRESS_ANOTHER_TEST_VARIABLE: prsnlmgr-713a4
  with:
    start: npm start
    wait-on: "http://localhost:3000"
    record: false
    parallel: false

• 在cypress.config.js中显式导入环境变量：

const { defineConfig } = require('cypress')

module.exports = defineConfig({
  env: {
    PROJECT_ID: process.env.PROJECT_ID,
    // 其他自定义变量...
  }
})

3. 确认变量读取方式 #

确保项目代码中是通过Cypress.env('PROJECT_ID')读取变量，而非直接访问process.env.PROJECT_ID。Cypress对带CYPRESS_前缀的变量有特殊处理逻辑，但内置变量会打破这个规则。

4. 检查版本兼容性 #

当前使用的是cypress-io/github-action@v5，可以尝试升级到最新版本（如v6），或者匹配本地使用的Cypress版本，避免版本不兼容导致的变量传递异常。

内容的提问来源于stack exchange，提问作者Дмитрий Середа