「[[マイクロソフト系技術情報 Wiki>http://techinfoofmicrosofttech.osscons.jp/]]」は、「[[Open棟梁Project>https://github.com/OpenTouryoProject/]]」,「[[OSSコンソーシアム .NET開発基盤部会>https://www.osscons.jp/dotNetDevelopmentInfrastructure/]]」によって運営されています。

-[[戻る>NuGet]]

* 目次 [#z19e7331]
#contents

*概要 [#fa0976f2]
-NuGetパッケージで展開されているモジュール内の~
デバッグ実行が必要になった時の手順も確立しておく必要がある。

-以下の2つの方法がある。
--（Primary packageに）PDBを同梱
--Symbol Packageを利用

*パッケージの登録 [#nd4008c8]

**（Primary packageに）PDBを同梱 [#u34263f8]
「[[NuGetパッケージの開発と公開]]」を参照。

***ポイント [#j842631b]
-'*.pdbファイル以外のすべてのファイル（*.dll、*.pdb、*.xml）を含める。
-'*.pdbを同梱する場合は、ビルド時のフォルダ構成に注意すること（開発環境と一致させる）。~
ただし「[[ビルド環境と開発環境のソースファイルパスを一致させる（PDB）。]]」で対応できる。

***手順 [#v3230e25]
-[[nuspecファイルの書き方の例>NuGetパッケージの開発と公開#ufd9e6b0]]

-[[NuGetパッケージの作成方法>NuGetパッケージの開発と公開#g07875e2]]

-パッケージ名~
{identifier}.nupkg

**Symbol Packageを利用 [#e3f16568]
NuGetは、Symbol Packageを作成し、SymbolSourceリポジトリに公開することもサポート

***ポイント [#tedb06ca]
-*.dll、*.pdb、*.xmlに加え、ソースファイル（任意）を同梱。
-libフォルダの構造はPrimary packageと完全に同じにする。
-追加で、ソースファイルのルートフォルダをsrcに指定する。

***準備 [#s8839bef]
-nuspecファイルの書き方の例（srcはソースファイルのルートフォルダ）
 <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を解凍して>NuGetパッケージの開発と公開#p66307ac]]、同梱されるソースファイルを確認できる。

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

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

***登録 [#h43a29c4]
-概要
--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://api.nuget.org/v3/index.json
 nuget push *.symbols.nupkg -source https://nuget.smbsrc.net/

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

***nuget push 補足説明 [#b52a5ebb]
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 された際、
--XXXX側のPDB ファイルのソースの検索方法が書き換えられ、
--ソースの検索先が symbolsource.org になる。

*パッケージのデバッグ [#zd224c6d]

**（Primary packageに）PDBを同梱 [#uce0e316]
-*.pdbファイルが同梱されていれば、そのままデバッグ可能。
-ただし、[[ソースファイルの配置>#a439cd53]]については考慮が必要。

**Symbol Packageを利用 [#d56a4093]
-*.pdbファイルとソース ファイルを自動的に取得してソース コードのステップ インが可能

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

--「シンボル サーバ」、「ソース サーバ」を有効にする。~
[ツール] ---> [オプション] ---> [デバッグ] ---> [全般]
---[マイ コードのみを有効にする]のチェックを外す。
---[.NET Framework ソースのステッピングを有効にする]のチェックを外す。

--[[ソース サーバのサポートを有効にする。>ビルド環境と開発環境のソースファイルパスを一致させる（PDB）。#oa07a535]]

--[[ソース サーバ、シンボル サーバの場所を追加する。>ビルド環境と開発環境のソースファイルパスを一致させる（PDB）。#uf34ac5a]]~
---https://www.symbolsource.org/Public/Wiki/Using~
（同じバイナリのシンボルが含まれている場合があるため、順序に注意する。）
>
+http://referencesource.microsoft.com/symbols
+http://srv.symbolsource.org/pdb/Public~
or the authenticated variant (see above)
+http://srv.symbolsource.org/pdb/MyGet~
or the authenticated variant (see above)
+(other symbol servers with sources)
+http://msdl.microsoft.com/download/symbols
+(other symbol servers without sources)

*参考 [#w508407e]
**Microsoft Docs [#q57486a9]
-NuGet パッケージの作成方法~
https://docs.microsof.com/ja-jp/nuget/create-packages/creating-a-package
--NuGet パッケージのプレリリース版~
https://docs.microsoft.com/ja-jp/nuget/create-packages/prerelease-packages
--NuGet シンボル パッケージの作成方法~
https://docs.microsoft.com/ja-jp/nuget/create-packages/symbol-packages

-NuGet パッケージの公開方法~
https://docs.microsoft.com/ja-jp/nuget/create-packages/publish-a-package

-NuGet Command-Line Interface (CLI) Reference~
https://docs.microsoft.com/en-us/nuget/tools/nuget-exe-cli-reference
--NuGet CLI pack command~
https://docs.microsoft.com/en-us/nuget/tools/cli-ref-pack
--NuGet CLI push command~
https://docs.microsoft.com/en-us/nuget/tools/cli-ref-push

**SymbolSource.org [#h860d743]
Your source for debugging symbols... and sources.~

-HOME | What does it do?~
https://www.symbolsource.org/Public/
-Help | Using~
https://www.symbolsource.org/Public/Wiki/Using

-Register~
https://www.symbolsource.org/Public/Account/Register

-Metadata
--Public~
http://www.symbolsource.org/Public/Metadata
--MyGet~
http://www.symbolsource.org/MyGet/Metadata

**デバッグ可能なNuGetパッケージのサンプル [#nacbfc35]
https://github.com/OpenTouryoProject/SampleProgram/tree/master/NeGet

**[[ビルド環境と開発環境のソースファイルパスを一致させる（PDB）。]] [#a439cd53]

----
Tags: [[:.NET開発]], [[:デプロイ]], [[:デバッグ]], [[:NuGet]]
トップ   新規 一覧 単語検索 最終更新   ヘルプ   最終更新のRSS