如何在Codemagic免费版Flutter项目中创建被.gitignore忽略的.env文件

核心思路 #

利用Codemagic的环境变量管理功能存储敏感配置，通过构建前脚本动态生成.env文件——这个文件属于构建临时文件，不会被提交到仓库，完全符合.gitignore的忽略要求。

具体步骤 #

1. 在Codemagic中配置环境变量

   • 打开你的Codemagic项目，进入App settings > Environment variables
   • 点击Add variable，将本地.env中的每个键值对单独添加：比如输入API_KEY作为变量名，对应的值填实际密钥，敏感内容记得勾选Secure选项隐藏显示
   • 重复操作，把所有需要的配置项添加完成

2. 编写构建前脚本生成.env文件

   • 进入项目的Workflow > Pre-build script，添加以下脚本：

     # 在项目根目录生成.env文件
     echo "API_KEY=$API_KEY" > .env
     echo "BASE_URL=$BASE_URL" >> .env
     # 按需追加更多配置项，格式为echo "KEY=$VALUE" >> .env
     

   • 如果你的.env需要放在特定子目录（比如lib/.env），修改路径即可：

     echo "API_KEY=$API_KEY" > lib/.env
     

3. 排查之前脚本失败的常见问题

   • 路径错误：确认脚本生成的.env路径和Flutter项目读取路径一致，Codemagic默认工作目录是项目根目录
   • 变量名不匹配：脚本中引用的变量名要和Codemagic里配置的完全一致（区分大小写）
   • 目录不存在：如果要生成到子目录，先创建目录：mkdir -p lib/config && echo "API_KEY=$API_KEY" > lib/config/.env

验证方法 #

非敏感场景下，可以在脚本末尾添加cat .env，构建时查看日志就能确认.env是否正确生成。

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