psake / psake/PowerShellBuild

Compiling drops a hand-written about_<Module>.help.txt unless CopyDirectories names the culture directory

オープン
#210 コメント 2 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

bug
主要言語
PowerShell
スター
145
フォーク
27
平均マージ
10時間 16分
マージ済み PR(30日)
34

説明

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:

  1. *.psm1, *.psd1 and *.ps1xml at depth 1
  2. whatever $PSBPreference.Build.CopyDirectories names
  3. the concatenated *.ps1 files from CompileDirectories, 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

  1. Stage <Culture>/ automatically in compile mode, the way *.psd1 and *.psm1 are staged, since a culture directory is part of a module rather than incidental content. Closest to what a consumer expects, and makes CopyDirectories = @("en-US") unnecessary rather than load-bearing.
  2. Stage any about_*.help.txt found under a culture directory, narrower than (1) — it would not bring Messages.psd1 or other localized data along, which some modules do want and others may not.
  3. Warn when compiling if a culture directory exists in source and CopyDirectories does not name it. No behavior change; makes the silent drop visible. Weakest, but the least likely to surprise anyone.
  4. Document it in the CopyDirectories settings 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.

コントリビューションガイド

コントリビューションガイドを開く

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

Build-PSBuildModule の compile-mode における staging ロジックから始め、非コンパイルのコピー パスと比較してください。Culture ディレクトリまたは about topics をどのように扱うかを決める前に、関連する issue #206 と #207 を確認してください。合意した動作が実装され、手書きの about topic がコンパイル済みパッケージから暗黙に欠落しなくなれば完了です。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
powershell
領域
build-system
issue の種類
バグ
難易度
4/5
見積もり時間
3〜5日
活発さ
活発
明瞭さ
おおむね明確
初心者へのやさしさ
42/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。