如何在Heroku每次构建前为create-react-app项目设置环境变量
基于Create React App + Heroku 构建前动态配置Rollbar code_version的落地方案
前期三类方案的失败原因定位
- 第一类方案报
/bin/sh: 1: config:set: not found:Heroku的构建阶段运行环境并未预装herokuCLI工具,调用heroku config:set时找不到对应可执行文件,自然触发命令不存在的报错。 - 第二类方案“无报错但变量未生效”:一方面构建环境没有heroku CLI,
heroku config:set命令本身是静默执行失败的;另一方面即便CLI存在,heroku config:set的作用是修改Heroku平台侧的远端应用固定配置,不会将变量注入到当前构建流程的进程环境中,无法被后续构建步骤读取。 - 第三类方案在shell脚本里执行
export不生效:Create React App仅会读取启动构建命令的父进程携带的REACT_APP_开头的环境变量。在heroku-prebuild钩子拉起的独立shell子进程里执行export,变量作用域仅存在于当前临时shell,等prebuild执行完成后shell进程就会被销毁,后续正式运行react-scripts build的独立进程根本无法读取之前的临时变量。
正确实现的核心逻辑
我们的目标不是修改Heroku后台的长期固定配置,而是在每次构建流程启动时,把动态生成的code_version注入到Create React App可识别的环境变量链路里,让变量能被正确打包进前端产物,同步用于Rollbar初始化和Source Map上传。
分步实现操作
1. 调整package.json的构建执行链路
废弃heroku-prebuild钩子做环境注入的逻辑,把变量注入、构建、source map上传的逻辑全部整合到build脚本的同一条命令链路里,保证流程顺序执行无隔离:
{ "scripts": { "build": "node ./scripts/inject-build-env.js && react-scripts build && sh upload-source-maps-script.sh" } }
2. 编写动态环境注入脚本
在项目下新建scripts/inject-build-env.js,利用Create React App内置的.env文件读取规则,动态生成当前构建对应的版本号并写入项目根目录的.env文件——这是最稳定的变量注入方式,完全绕开不同进程间的作用域隔离问题:
const fs = require('fs'); const { execSync } = require('child_process'); // 动态生成code_version,可替换为你需要的规则,比如git短哈希、发布版本号 const codeVersion = execSync('git rev-parse --short HEAD').toString().trim(); // 写入.env文件,Create React App构建启动时会自动加载该文件下所有REACT_APP_开头的变量 const envFileContent = `REACT_APP_ROLLBAR_CODE_VERSION=${codeVersion}\n`; fs.writeFileSync('./.env', envFileContent);
3. 前端代码对接Rollbar配置
在前端初始化Rollbar的逻辑里,直接读取构建时注入的环境变量即可,无需额外处理:
import Rollbar from 'rollbar'; const rollbar = new Rollbar({ accessToken: '你的前端Rollbar访问令牌', captureUncaught: true, captureUnhandledRejections: true, // 直接使用构建时注入的版本号 codeVersion: process.env.REACT_APP_ROLLBAR_CODE_VERSION, payload: { environment: process.env.NODE_ENV } });
4. 对齐Source Map上传的版本号规则
在之前的upload-source-maps-script.sh里,读取.env文件里存储的REACT_APP_ROLLBAR_CODE_VERSION值,和构建时用的版本号保持完全一致再上传,避免出现错误堆栈和source map关联失败的问题。
关键避坑提示
- 不要在构建流程中使用
heroku config:set做变量注入:该命令本质是修改平台侧的持久化应用配置,既会因为构建环境无CLI触发静默失败,也无法满足每次构建动态生成版本号的需求。 - 不要把动态生成的.env文件提交到代码仓库:在项目.gitignore配置中加入
.env,避免临时构建配置污染代码库。 - 统一版本号的取值逻辑:从动态生成、Rollbar初始化、到Source Map上传全链路使用同一个版本号值,不要出现不同环节取值规则不一致的情况。
内容的提问来源于stack exchange,提问作者Адильхан Сатемиров
相关产品推荐
相关产品推荐

