Skip to content

build: Release 打出的 .vpx 不再带 .pdb 与 API 文档 .xml - #180

Merged
joesdu merged 1 commit into
mainfrom
dev
Nov 17, 2026
Merged

joesdu merged 1 commit into
mainfrom
dev

Conversation

@joesdu

@joesdu joesdu commented Nov 17, 2026

Copy link
Copy Markdown
Collaborator

主要改动

Release 打出的 .vpx 不再带 .pdb 与 API 文档 .xml。

原因:SDK 的 PackVpx 把整个 $(TargetDir) 原样打进包。已发布的 2.1.9 里,8 个插件共带了 20 个 pdb/xml(每个插件自己的,外加 VelaShell.Rdp、VelaShell.Vnc 的)。插件包 GetVelaPluginPayload 原本就排除了它们,只有 .vpx 这条路漏了。

改法(plugins/Directory.Build.props,只对 Release、只对插件工程):

  • CopyOutputSymbolsToOutputDirectory / CopyDocumentationFileToOutputDirectory = false:插件自己的 pdb 与 xml 照常生成在 obj/(文档注释的编译告警照常生效),只是不复制到 bin/;
  • AllowedReferenceRelatedFileExtensions 写成 MSBuild 默认清单去掉 .pdb;.xml:被引用工程的 pdb/xml 不再随引用带进来(留空会回落到含这两项的默认值,所以必须显式写)。

输出目录本身干净了,PackVpx、GetVelaPluginPayload、artifacts/plugins 暂存三条路一次全对,不需要清理步骤,也不用改 SDK。plugins/Directory.Build.targets 只更新了注释。

不变的:Debug 构建照旧带 pdb(本机宿主挂调试器要用);测试在 Debug 下跑,不受影响。
代价:Release 包里的插件抛异常时,堆栈不带源码行号。

验证

  • 清掉 Release 输出后重新 PackAllVpx,用 SDK 自己的 VpxContainer 打开每个 .vpx 列出内容:8 个包 0 个 pdb/xml。同样的方法检查 Release 上的 2.1.9:20 个。
  • 8 个包合计 10.72MB → 9.45MB(pdb/xml 压缩率高,压缩后省约 1.27MB;未压缩约 4.6MB,其中 Mongo 一个 2.27MB)。
  • Debug 构建 bin/ 里 pdb/xml 照旧;Release 的 obj/ 里两者照旧生成。
  • CI 的 Release 打包命令与本机跑的相同。

文档

不涉及文档修改:打包产物的内容不在 velashell-docs 的描述范围内,本仓库 README 也没有写过包里带 pdb。

SDK 的 PackVpx 把整个 $(TargetDir) 原样打进 .vpx,于是 2.1.9 的 8 个包里共带了
20 个 pdb/xml(含 VelaShell.Rdp、VelaShell.Vnc 的)。在 plugins/Directory.Build.props 里
对 Release 构建:

- CopyOutputSymbolsToOutputDirectory / CopyDocumentationFileToOutputDirectory = false:
  插件自己的 pdb 与 xml 照常生成在 obj/(文档注释告警不受影响),只是不复制到 bin/;
- AllowedReferenceRelatedFileExtensions 写成默认清单去掉 .pdb;.xml:被引用工程的
  pdb / xml 不再随引用带进来(留空会回落到含 .pdb;.xml 的默认值)。

输出目录本身干净了,PackVpx、GetVelaPluginPayload、artifacts/plugins 暂存三条路一次全对。
Debug 不变(本机宿主挂调试器要 pdb)。代价:Release 包里插件的异常堆栈不带源码行号。
@joesdu
joesdu merged commit 5eaaf8d into main Nov 17, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant