NuGetパッケージのデバッグのバックアップ(No.15)

<files>
    <file src="Full\bin\Debug\*.dll" target="lib\net40" />
    <file src="Full\bin\Debug\*.pdb" target="lib\net40" />
    <file src="Silverlight\bin\Debug\*.dll" target="lib\sl40" />
    <file src="Silverlight\bin\Debug\*.pdb" target="lib\sl40" />
    <file src="**\*.cs" target="src" />
</files>

nuspecファイルは、Primary PackageとSymbol Packageで共有（１つ）で良い（理由は後述）。
「src="**\*.cs"」の「**」は、再帰的にフォルダを検索することを意味するので、
- 階層構造がある src でも正しく同梱することが可能。
- 必要であれば、作成したPackageを解凍して、同梱されるソースファイルを確認できる。

作成方法
- 以下のコマンドで、symbolとsrcが除外されたPrimary Packageと、Symbol Packageが生成される。
```
nuget pack [*.nuspecファイルパス] -Symbols
```
- Primary Packageにもsymbolとsrcを含めたい場合、別途、以下のコマンドを実行する。
```
nuget pack [*.nuspecファイルパス]
```

パッケージ名
{identifier}.symbols.nupkg

↑

登録 †

概要
- NuGetプロトコルを実装するnuget.exe v4.1.0以上を使用
- nuget.orgとsymbolsource.orgの両方に登録を行う。

操作

便宜上、NuGetを使用してAPIキーを保存
```
nuget SetApiKey Your-API-Key
```

Symbol Packageをプッシュ

Primary packageをプッシュした後に、Symbol Packageをプッシュ
（*.symbols.nupkgとあれば自動的にsymbolsource.orgがターゲットになる。）
```
nuget push *.symbols.nupkg
```

Sourceオプションを使用して、Symbol Repositoryにプッシュ
Symbol Packageを別のSymbol Repositoryにプッシュ
若しくは、命名規則に従わないSymbol PackageをSymbol Repositoryにプッシュ
```
nuget push *.symbols.nupkg -source https://nuget.smbsrc.net/
```

Primary package、Symbol Packageの両方をプッシュ
Primary package、Symbol Packageの両方を、同時に両方のRepositoryにプッシュすることもできる。
```
nuget push *.nupkg
```

nuget.exe 4.5.0以降、
Primary package、Symbol Packageを[-source]を指定して個別にプッシュ。

nuget SetApiKey [ApiKey]
nuget push *.nupkg -source https://www.nuget.org/
nuget push *.symbols.nupkg -source https://nuget.smbsrc.net/

※ https://nuget.smbsrc.net/ は、symbolsource.orgのプッシュURL。

↑

nuget push 補足説明 †

nuget.exe による、*.symbols.nupkg の push の補足説明

symbolsource.orgへのサインイン
- SetApiKey? で保存された APIキーを nuget.org と symbolsource.org の両方に対して使用する。
- symbolsource.org ではこの API キーを使用して nuget.org へ確認するため、
  symbolsource.org にサインインせずSymbol Packageのアップロードが可能。

PDB ファイルの書換
nuget.exe push で symbolsource.org に push された際、
- symbolsource.org側のPDB ファイルのソースの検索方法が書き換えられ、
- ソースの検索先が symbolsource.org になる。

↑

ハイブリッドな方法 †

以下の手順で、Primary packageのPDBとSymbol Packageを切替え可能にできる。

↑

nspecを2つ用意する。 †

Primary package用

<files>
    <file src="Full\bin\Debug\*.dll" target="lib\net40" />
    <file src="Full\bin\Debug\*.pdb" target="pdb\net40" /> ※ pdbの場所を外す。
</files>

Symbol Package用

<files>
    <file src="Full\bin\Debug\*.dll" target="lib\net40" />
    <file src="Full\bin\Debug\*.pdb" target="lib\net40" />
    <file src="**\*.cs" target="src" />
</files>

↑

其々、Package化する。 †

Primary package用
```
nuget pack [*.nuspecファイルパス]
```

Symbol Package用 ※ Primary packageを上書きするので注意！
```
nuget pack [*.nuspecファイルパス] -Symbols
```

※ このため、出力先を分けるといい。

↑

Push前の確認。 †

必要に応じて、Push前の確認を行う。

↑

其々、Pushする。 †

Primary package用

nuget push *.nupkg -source https://www.nuget.org/

Symbol Package用

nuget push *.symbols.nupkg -source https://nuget.smbsrc.net/

※ Symbol PackageフォルダにPrimary packageは不要。

↑

パッケージのデバッグ †

↑

（Primary packageに）PDBを同梱 †

*.pdbファイルが同梱されていれば、そのままデバッグ可能。
ただし、ソースファイルの配置については考慮が必要。

↑

Symbol Packageを利用 †

*.pdbファイルとソースファイルを自動的に取得してソースコードのステップインが可能

ただし、以下の設定が必要になる。

ソースサーバのサポートを有効にする。

シンボルサーバの場所を追加する。

基本的に、以下のURLを追加するだけでよい。
https://www.symbolsource.org/Public/Wiki/Using

複数のサーバを使用する場合、
同じバイナリのシンボルが含まれている場合があるため、
順序に注意する（下記順序に従ってURLを追加する）。
1. http://referencesource.microsoft.com/symbols
2. http://srv.symbolsource.org/pdb/Public
  or the authenticated variant (see above)
3. http://srv.symbolsource.org/pdb/MyGet
  or the authenticated variant (see above)
4. (other symbol servers with sources)
5. http://msdl.microsoft.com/download/symbols
6. (other symbol servers without sources)