Compiling drops a hand-written about_<Module>.help.txt unless CopyDirectories names the culture directory
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 42/100
- Issue 类型
- 缺陷
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- powershell
- 领域
- build-system
调研方向
从 Build-PSBuildModule 的 compile-mode 暂存逻辑入手,并将其与非编译复制路径进行比较。在决定应如何处理 Culture 目录或 about topics 之前,先查看相关 issue #206 和 #207。完成的标准是实现约定的行为,使手写的 about topic 不再静默地缺失于编译后的包中。
由索引模型根据 Issue 内容生成。
描述
Found while surveying how consumers configure PowerShellBuild, for the decisions on #206 and #207. Verified in packages already published to the PowerShell Gallery, so this is affecting real modules today rather than being a hypothetical.
What happens
In compile mode, Build-PSBuildModule stages only three things into the output:
*.psm1,*.psd1and*.ps1xmlat depth 1- whatever
$PSBPreference.Build.CopyDirectoriesnames - the concatenated
*.ps1files fromCompileDirectories, written into the root module
A hand-written en-US/about_<Module>.help.txt in the source tree is none of those. It is silently left behind, and the built module ships without its about topic. The build reports success.
Non-compile mode is unaffected: it does a bulk Copy-Item $Path/* -Recurse -Force, so the whole source tree including en-US/ arrives in the output.
Evidence from published packages
Downloaded the .nupkg for five consumers that ship a hand-written about topic in source:
| Module | CopyDirectories |
About topic in the published package |
|---|---|---|
PowerShellOrg/Plaster |
@(en-US, Schema, Templates) |
ships |
PowerShellOrg/PSDepend |
@(PSDependScripts, en-US) |
ships |
diecknet/DavinciTimestamp |
not set | dropped |
poshbotio/PoshBot.FYI |
not set | dropped |
pauby/PsTodoTxt |
not set | dropped |
All five have about_*.help.txt in their source tree. The only thing separating the two groups is whether CopyDirectories happens to name the culture directory.
For the three affected modules the published en-US/ contains only the platyPS-generated MAML (<Module>-help.xml). Get-Help about_<Module> returns nothing for their users.
Why it is easy to miss
Nothing warns. The consumer sees a green build and a package that looks complete, and the file they wrote is simply absent. It is the same shape as #201 and #207 — a plausible-looking artifact with something quietly missing — and the three affected authors presumably do not know.
It is also not obvious from the settings. CopyDirectories reads as an escape hatch for extra content, not as the mechanism by which help files reach the output; a consumer who ships an about topic has no particular reason to think it applies to them.
Scope
14 of the 86 surveyed public consumers ship a hand-written about topic. Four of those compile. Three of the four are affected; the fourth (Plaster) is safe only because it sets CopyDirectories for unrelated reasons.
Options
- Stage
<Culture>/automatically in compile mode, the way*.psd1and*.psm1are staged, since a culture directory is part of a module rather than incidental content. Closest to what a consumer expects, and makesCopyDirectories = @("en-US")unnecessary rather than load-bearing. - Stage any
about_*.help.txtfound under a culture directory, narrower than (1) — it would not bringMessages.psd1or other localized data along, which some modules do want and others may not. - Warn when compiling if a culture directory exists in source and
CopyDirectoriesdoes not name it. No behavior change; makes the silent drop visible. Weakest, but the least likely to surprise anyone. - Document it in the
CopyDirectoriessettings row and the README. Cheapest; leaves three published modules broken and the next consumer to hit it none the wiser.
I lean (1). A module's culture directory carries its localized data and its about topics, and dropping it while carefully copying the manifest is hard to justify as intended behavior. But it changes what lands in the output for every compiling consumer, so it is a maintainer call.
Related: #206 and #207 are also in Build-PSBuildModule's staging logic, and #207 in particular concerns the same culture directory. Worth deciding the three together.
- 主要语言
- PowerShell
- 星标
- 145
- 派生
- 27
- 平均合并
- 10 小时 16 分钟
- 30 天内合并 PR
- 34
贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
psake/PowerShellBuild 的其他 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 72/100
psake/PowerShellBuild#218 · 1 条评论 ·
-
bug
难度 2/5 1-3 小时 新手友好度 74/100
psake/PowerShellBuild#211 · 1 条评论 ·
-
CI: Install the built module from a local repository to verify install-time dependency behaviour 未关闭enhancement github_actions
难度 4/5 3-5 天 新手友好度 68/100
psake/PowerShellBuild#229 ·
-
bug
难度 3/5 1-2 天 新手友好度 55/100
psake/PowerShellBuild#222 ·
-
bug
难度 4/5 3-5 天 新手友好度 68/100
psake/PowerShellBuild#221 ·
查看 psake/PowerShellBuild 的全部 Issue
相似的 Issue
-
难度 1/5 1 小时以内 新手友好度 85/100
-
bug
难度 1/5 1 小时以内 新手友好度 90/100
-
area:engineering priority:p2 type:bug
难度 2/5 1-3 小时 新手友好度 75/100
jejjohnson/pyrox#234 ·
-
good first issue
难度 1/5 1 小时以内 新手友好度 90/100
-
good first issue
难度 1/5 1 小时以内 新手友好度 85/100
ros2/ros2_tracing#266 · 1 条评论 ·