ARTICLE · INTELLIGENCE

战地情报 · 详情页

来自尧图项目组的一线实战观察与深度解析

.NET Runtime 安装包第三方声明(THIRD-PARTY-NOTICES)的生成与分发机制详解

.NET Runtime 安装包第三方声明(THIRD-PARTY-NOTICES)的生成与分发机制详解 .NET Runtime 安装包第三方声明THIRD-PARTY-NOTICES的生成与分发机制详解【免费下载链接】runtime.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.项目地址: https://gitcode.com/GitHub_Trending/runtime6/runtime本文围绕 dotnet/runtime 仓库中 src/installer/pkg/README.md 所阐述的第三方声明文件机制展开说明THIRD-PARTY-NOTICES.TXT如何在 .NET Host 安装包中生成、聚合与安装为什么它需要每个版本更新以及它与仓库根目录同名文件的职责边界。读完本文你将掌握该文件在安装包产物中的最终落盘位置、上游仓库聚合清单、自动化再生成任务的调用链以及如何在不破坏构建的前提下查看与验证这份合规文件。背景为什么安装包需要一份汇总版第三方声明.NET Runtime 是一个横跨 CoreCLR、NativeAOT、Mono 与数百个基础库的跨平台运行时。安装包installer不仅打包本仓库编译出的二进制还会把来自 ASP.NET Core、Windows Forms、WPF、模板引擎、Roslyn 分析器等多个上游仓库的组件一起安装到用户的dotnet目录下。这些上游组件各自拥有独立的许可证与第三方声明单靠仓库根目录的那一份THIRD-PARTY-NOTICES.TXT无法覆盖。这正是src/installer/pkg/README.md要解决的问题在src/installer/pkg/目录下维护一份覆盖所有向dotnet目录安装文件的仓库的聚合第三方声明并将其随 .NET Host 安装包一起交付给最终用户。两份 TPN 文件的职责边界文件位置覆盖范围分发方式src/installer/pkg/THIRD-PARTY-NOTICES.TXTsrc/installer/pkg/目录所有向dotnet目录安装文件的仓库ASP.NET Core、WinForms、WPF 等随 .NET Host 安装包安装到dotnet目录THIRD-PARTY-NOTICES.TXT仓库根目录仅本仓库dotnet/runtime自身随源码仓库分发不进安装包README 原文明确了两者关系src/installer/pkg/THIRD-PARTY-NOTICES.TXT是各上游仓库 TPN 的集合而根目录的 TPN 只描述当前仓库自身。从仓库结构看src/installer/pkg/ 下还并列存放着LICENSE-MSFT.TXT微软 .NET Library 的许可条款与README.md三者共同构成安装包的许可证材料组。TPN 文件的内容结构以仓库当前 src/installer/pkg/THIRD-PARTY-NOTICES.TXT 为实例共 1468 行其典型结构如下引言段落声明 .NET Runtime 可能使用许可证不同于 .NET Runtime 自身的第三方库或资源并列出联系邮箱dotnetmicrosoft.com用于处理漏列声明的情况许可通知区块Section每个上游组件一个区块例如License notice for ASP.NET—— 版权归 .NET FoundationMIT 许可证License notice for Slicing-by-8—— Intel 版权BSD 许可证CRC 等算法场景常见依赖License notice for Unicode data—— Unicode, Inc. 版权遵循 Unicode Terms of Use其余区块按上游仓库聚合顺序排列。值得注意的是文中声明附带的声明仅供参考provided for information only即 TPN 文件本身不改变任何组件的实际许可证仅履行开源许可证的署名与告知义务。上游仓库聚合清单与自动化再生成src/installer/pkg/README.md强调该文件应当手动或自动更新为每个发布版本纳入新的 TPN。仓库提供了一条完整的自动化链路入口在 eng/regenerate-third-party-notices.proj1. 构建入口eng/Subsets.props构建系统将再生成第三方声明注册为按需子集SubsetName IncludeRegenerateThirdPartyNotices OnDemandtrue DescriptionRegenerates the THIRD-PARTY-NOTICES.TXT file based on other repos TPN files. /同时eng/Subsets.props中ProjectToBuild引用了eng/regenerate-third-party-notices.proj并把 CI 管道如eng/pipelines/coreclr/ci.yml、eng/pipelines/global-build.yml中对THIRD-PARTY-NOTICES.TXT的变更纳入路径评估确保文件变更会触发相关构建/测试。2. 聚合配置eng/regenerate-third-party-notices.projTpnFile$(InstallerProjectRoot)pkg\THIRD-PARTY-NOTICES.TXT/TpnFile TpnRepo Includedotnet/runtime / TpnRepo Includedotnet/aspnetcore / TpnRepo Includedotnet/installer / TpnRepo Includedotnet/roslyn-analyzers / TpnRepo Includedotnet/templating / TpnRepo Includedotnet/winforms / TpnRepo Includedotnet/wpf /注释明确说明TPN 在 dotnet/runtime 中服务的远不止其自身的依赖图因为 runtime 产出的安装包会把唯一一份 TPN 文件放到dotnet主目录未设置Branch元数据的仓库默认使用main分支Condition%(TpnRepo.Branch) 文件名的候选形态覆盖大小写与扩展名差异THIRD-PARTY-NOTICES.TXT、THIRD-PARTY-NOTICES.txt、THIRD-PARTY-NOTICES、THIRDPARTYNOTICES.TXT、THIRDPARTYNOTICES.txt注释中还列出应当包含但目前没有 TPN 文件的额外仓库efcore、emsdk、extensions、icu、sdk、windowsdesktop这类仓库会被跳过而非报错。3. 底层实现RegenerateThirdPartyNotices任务任务类位于 src/tasks/installer.tasks/StaticFileRegeneration/RegenerateThirdPartyNotices.cs核心流程如下并发抓取ExecuteAsync使用HttpClient对每个(仓库, 分支, 候选文件名)组合构造https://raw.githubusercontent.com/{org}/{repo}/{branch}/{path}请求并Task.WhenAll并发拉取容错解析只有返回非404的内容才进入TpnDocument.Parse404视为该仓库没有此文件名继续尝试下一个候选唯一性校验按仓库分组后若每个仓库找到的 TPN 数量不等于 1则记录构建错误Unable to find exactly one TPN for {repo}防止遗漏或歧义增量合并解析现有TpnFile用TpnSection.ByHeaderNameComparer做集合差集仅把新增的声明区块追加进去并按区块头名称排序写入文件File.WriteAllText(TpnFile, newTpn.ToString())。这解释了 README 中手动或自动更新的含义自动路径由该 MSBuild 任务保证每个版本从上游同步最新 TPN手动路径则是各仓库负责人先在上游更新 TPN 后再由 runtime 发布流程聚合。TPN 如何进入 .NET Host 安装包README 明确指出该文件包含在 .NET Host 安装包中并安装到 dotnet 目录。实现位于 src/installer/pkg/sfx/installers/dotnet-host.proj 的PublishToDisk目标FilesToPublish Include$(InstallerProjectRoot)pkg\THIRD-PARTY-NOTICES.TXT Destination$(OutputPath)ThirdPartyNotices.txt /同时发布的还有dotnet$(ExeSuffix)—— .NET Host 可执行文件LICENSE.TXT—— 随平台切换来源Unix 使用仓库根目录 LICENSE.TXT非 UnixWindows使用 src/installer/pkg/LICENSE-MSFT.TXTdnx/dnx.cmd/dnx.dispatcher—— 命令分发器Unix 上额外的dnx.dispatcher被标记InstallerOnlytrue用于 Linux 包安装后与文件触发脚本的修复场景。注意目标文件名为ThirdPartyNotices.txt驼峰命名与源文件THIRD-PARTY-NOTICES.TXT不同——这是安装到dotnet目录后的实际文件名阅读安装后产物时可通过该名字定位。平台相关的许可证文件选择dotnet-host.proj中的条件体现了跨平台打包差异条件采用的许可证文件说明TargetsUnix true$(RepoRoot)LICENSE.TXTLinux/macOS 等 Unix 平台使用仓库 MIT 许可证TargetsUnix ! truepkg\LICENSE-MSFT.TXTWindows 平台使用微软 .NET Library 许可条款查看与验证方式仓库是只读的以下操作只涉及查看与验证不修改任何文件直接阅读聚合 TPN打开 src/installer/pkg/THIRD-PARTY-NOTICES.TXT可按 License notice for ... 区块标题检索各上游组件核对安装产物构建 .NET Host 安装包后在输出目录检查ThirdPartyNotices.txt由PublishToDisk目标生成按需重跑聚合执行./build.sh -subset RegenerateThirdPartyNoticesWindows 用build.cmd观察 MSBuild 输出中每个仓库的抓取 URL 与Found TPN: {repo} [{branch}] {path}日志验证当前版本上游 TPN 是否完整对比两份 TPN根目录 THIRD-PARTY-NOTICES.TXT 只覆盖 runtime 自身src/installer/pkg下的是全量聚合版二者区块数量与覆盖仓库不同属正常现象。小结维护一份覆盖所有向dotnet目录安装文件的仓库的聚合 TPN 是安装包合规分发的必要条件聚合清单、候选文件名、分支选择均由 eng/regenerate-third-party-notices.proj 声明底层由 RegenerateThirdPartyNotices.cs 的并发抓取 增量合并实现文件在构建期由 dotnet-host.proj 以ThirdPartyNotices.txt之名随 Host 安装到dotnet目录每次发布前应通过自动或手动方式更新该文件将上游新增组件的许可声明纳入其中这是 .NET 发布流程中的合规底线。【免费下载链接】runtime.NET is a cross-platform runtime for cloud, mobile, desktop, and IoT apps.项目地址: https://gitcode.com/GitHub_Trending/runtime6/runtime创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
RELATED READING

延伸阅读

更多一线实战笔记与深度复盘,助您持续精进