Firefox iOS 如何新增 Nimbus 特性开关并管理 nimbus.fml.yaml 的 include 块【免费下载链接】firefox-iosFirefox for iOS项目地址: https://gitcode.com/GitHub_Trending/fi/firefox-ios如果你要在 Firefox for iOS 中新增一个由 Nimbus 驱动的特性开关feature flag需要完成两件事在firefox-ios/nimbus-features/目录下创建特性文件并让根清单firefox-ios/nimbus.fml.yaml的include块收录它。nimbus.fml.yaml文件开头的注释明确指出include块不应手工维护应使用仓库中iOSNimbusFeatureUtility脚本提供的文档化流程来完成。本文基于该脚本和清单文件的实际内容说明完整的操作路径与验证方式。特性开关的文件结构与 include 块的作用根清单 nimbus.fml.yaml 由三部分组成about块声明清单属性其中ios指定class: FxNimbus、module: Client即生成的特性对象所在的 Swift 类与模块channels块列出应用使用的频道developer、beta、releaseinclude块列出nimbus-features/目录下全部特性文件例如nimbus-features/adBlockerFeature.yaml。文件注释原文为“The features to be included in the nimbus.fml will be listed in theincludeblock. This should not be a manual process.”即 include 块应通过 iOSNimbusFeatureUtility.sh 生成而不是手动编辑。用脚本新增一个特性开关脚本的--add选项接受一个camelCase的特性名例如sampleFeature。在仓库根目录下执行sh archived-scripts/iOSNimbusFeatureUtility.sh --add sampleFeature执行前需要了解脚本的副作用均会直接修改仓库文件若名字不以Feature结尾脚本会自动补上因此sampleFeature对应新建文件firefox-ios/nimbus-features/sampleFeature.yaml。如果该文件已存在会被模板内容覆盖脚本随后执行等价的--update流程先删除nimbus.fml.yaml中所有包含nimbus-features的行再重新写入nimbus-features/目录中当前存在的全部.yaml文件。因此目录里未提交的实验性特性文件也会被一并注册进include块脚本会临时生成temp文件并重写nimbus.fml.yaml。执行成功后脚本输出Added new feature successfully Please remember to add the feature to the feature flag spreadsheet查看并编辑生成的特性文件--add会向新文件预填模板内容。以sampleFeature为例脚本写入的内容是# The configuration for the sampleFeature feature # Please remember to add this feature to the feature flag spreadsheet. features: sample-feature: description: Feature description variables: new-variable: description: Variable description type: Boolean default: false defaults: - channel: beta value: new-variable: false - channel: developer value: new-variable: false objects: enums:其中特性键是脚本把 camelCase 名字转换成的 kebab-casesampleFeature→sample-feature。模板中的Feature description、new-variable以及各频道的defaults都是待替换的占位内容需要改成该特性真实的变量定义。可以参照仓库中已填写完整的 adBlockerFeature.yaml它定义了enabled和badge-enabled两个 Boolean 变量并分别为beta和developer频道设置了defaults。单独刷新 include 块--update如果你手工新增或删除了nimbus-features/下的特性文件而不想走--add流程可以单独运行--updatesh archived-scripts/iOSNimbusFeatureUtility.sh --update--update只做一件事按nimbus-features/目录的实际文件列表重写nimbus.fml.yaml的include块。注意它与--add使用同一套重写逻辑同样会丢弃并重建 include 块目录中现有哪些.yaml就会收录哪些。不带参数运行脚本只会打印 “No arguments supplied.” 提示。验证新增结果1. 检查 include 块。打开 nimbus.fml.yaml确认include块中出现- nimbus-features/sampleFeature.yaml一行且其余特性的条目未被丢失它们应与nimbus-features/目录内容一一对应。2. 观察 CI 的 Danger 检查。Dangerfile.swift 中的checkForNimbusFeatureChange()会在 PR 中检测三类变更新增特性文件、删除特性文件、修改nimbus.fml.yaml。命中任一项时Danger 会发布 “Nimbus feature changes detected” 评论并提醒更新 Nimbus 特性跟踪电子表格spreadsheet——这与脚本成功输出中的提醒一致属于该流程文档化的固定收尾步骤。3. 构建项目确认代码生成。构建时Swift 代码由nimbus-fml工具链从 FML 文件生成该工具由 bootstrap.sh 的 firefox 分支从 application-services 下载并指向./firefox-ios/nimbus.fml.yaml。生成范围由 nimbus-fml-configuration.sh 的MODULES决定默认包含根nimbus.fml.yaml与nimbus-features/messaging/messaging.fml.yaml。该脚本还定义了 Xcode 构建配置与 Nimbus 频道的对应关系CONFIGURATIONCHANNELDebug、Fennec_Testing、Fennec_EnterprisedeveloperFirefoxStaging、FirefoxBetabetaFirefoxrelease注释强调频道必须与APP_FML_FILE即根清单中列出的channels一致。因此验证时选择与目标频道对应的构建配置例如在 Debug 配置下验证developer频道的defaults编译通过即说明新特性已进入 FML 生成链路。限制与注意事项脚本实际位于archived-scripts/目录但nimbus.fml.yaml的注释仍以iOSNimbusFeatureUtility之名指向它新增特性时按该脚本的文档化用法操作即可--add会覆盖同名已存在的特性文件重复执行前请先确认include 块完全由目录内容重建提交前请确保nimbus-features/下没有不应进入清单的临时.yaml文件特性文件被新增或删除、或清单被修改后需要同步更新 Danger 评论中指向的特性跟踪电子表格这是 CI 流程明确要求的后续动作。下一步用实验集成测试在模拟器中验证可选如果特性要参与真实实验验证仓库提供了实验集成测试入口见 tests.md。其前置条件为带模拟器设备的 Xcode、可用且工作正常的nimbus-cli、Python 3.11 或更高版本并通过pipenv install安装测试依赖。运行时需要提供实验 slug--experiment test-experiment测试针对 stage 服务器上的实验可加--stage-m smoke_test运行冒烟测试集。测试完成后报告生成在results目录下的index.html中用浏览器查看。【免费下载链接】firefox-iosFirefox for iOS项目地址: https://gitcode.com/GitHub_Trending/fi/firefox-ios创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
