NuGetパッケージの自動作成

アセンブリを転送したいコール

そして彼らと共に燃えるような挨拶

ヌガーを詰めることを忘れないでください

パッケージに！



この記事では、Microsoft .NETテクノロジスタックに焦点を当てることを直ちに予約します。



プロジェクトのサブセットがさまざまなソリューションで使用され始めることがよくあります。



原則として、近隣のプロジェクトで何か有用なものを見つけたプログラマーは、最初は気にしません-libフォルダー（dll、アセンブリなど）を作成し、そこに元のソリューションからコンパイル済みアセンブリを配置します。 時間が経つにつれて、これが最も便利なオプションではないことが明らかになります。その理由は次のとおりです。

• 元のソリューションは、「消費者」を考慮せずに独自の方向で開発を開始します。新しい依存関係が追加され、.netバージョンが更新されます。 「ジョーク」;
• 「消費者」について考える場合でも、重要な更新または新しいバージョンが出たときにアセンブリを更新するのを忘れ、複数のアセンブリがあり、それらの間にいくつかの依存関係があると、すべてが悪化します-1つのアセンブリを更新すると、実行時間 別のアセンブリのバージョンが間違っている可能性があります。
• 元のソリューションは現在開発されていません。

これらすべての問題に対する答えは、プロジェクトを個別のソリューションに持ち込み、共通のアセンブリを含むNuGetパッケージを作成し、これらのアセンブリの開発パラダイムを変更することです。 概して、これはすべてNuGetなしで実行できますが、あまり面白くありません。NuGetパッケージが、ビルドサーバーでのプロジェクトのコンパイルと一緒に自動的にビルドされ、必要なホイッスルとバズがすべて含まれることを確認する方法物語。

NuGetパッケージの作成

NuGetパッケージの作成プロセスは非常に簡単です。 一般的な理論部分全体にアクセスでき 、一般に理解できます。 パッケージは、コンパイルされたアセンブリだけでなく、デバッグシンボル、画像など、さまざまなコンテンツをパックするために使用できます。 リソース、さらにはソースコードです。



この説明では、コンパイル済みアセンブリのパッケージングという最も差し迫った問題に限定しています。

最初のNuGetパッケージの準備

ビルドサーバーでNuGetパッケージの自動作成をセットアップするには、パッケージの最初のバージョンを「調理」する必要があります。 パッケージを作成する最も簡単で理解しやすい方法は、パッケージの内容を説明するNuSpecファイルを使用することです。 このNuSpecファイルはさまざまな方法で取得できます。

• 他の人の例を取り上げて修正してください。
• NuGet.exeユーティリティで生成します（コマンド「NuGet.exe spec」）。
• NuGet Package Explorer GUIユーティリティで新しいパッケージを作成するか、既存の外部パッケージを開き、「メタデータに名前を付けて保存...」コマンドを使用して修正して保存します。

原則として、GUIでNuSpecファイルの作成全体を完了することは可能ですが、NuSpecの動作を理解することは依然として役立ちます。



たとえば、略語付きのNuSpecファイルの1つは次のようになります。





一部のセクションに関する説明を次に示します。

• Idは、衝突を避けるために、すべてのパッケージの共通ネームスペース内で一意でなければなりません。 誰かがパッケージの名前で会社の名前を示し 、次にプロジェクトの名前と特定の製品を示しますが、 誰かは気にしません。
• バージョンに関しては、 セマンティックバージョニングの原則を使用することをお勧めします。 チームで開発した小さなルール-すべてのプレリリースバージョン（3つの数字に加えて、たとえばalpha1など）、デバッグ構成で組み立てられたアセンブリとリリースでそれぞれ公開します。リリース中。
• リリースノート（releaseNotes）-非常に便利なことです。必ず前のバージョンから変更されたものをそこに書いてください。 ユーザーは、各更新で得られるものを理解する必要があります。
• 依存関係 依存関係を説明するときは、パッケージのインストール方法について考える必要があります。ユーザーが必要なのはパッケージだけで、それ以外は必要ない場合、依存関係はありません。 SharpZipLibなどの別のパッケージがある場合にのみアセンブリが機能する場合、この依存関係を登録する必要があります。 SharpZipLibは独自の依存関係を持ち、自宅で指定しなくても、インストール中にユーザーに「飛ぶ」ことを理解することが重要です。
  
  インストールは再帰的に行われるため、仮想的な状況のいずれかのユーザーは1つのパッケージのインストールを開始でき、依存関係を介して100を超えるパッケージがインストールされます。 パッケージのインストール中、依存パッケージのバージョンの選択は非常に注意が必要です。 バージョン番号を指定しない場合、最新のリリースバージョンがインストールされます。それ以外の場合は、依存関係で明示的に指定されたバージョンがインストールされます。 ところで、時々複数の無関係なパッケージを使用する場合、必要なパッケージに依存する空のパッケージを作成し、このパッケージを独自にインストールできます。残りはそれ自体の後にインストールされます。
• ファイルの説明には、特定の名前またはマスクが含まれる場合があります。 契約に従って、コンテンツタイプ、.netフレームワークのバージョンなどがターゲットに記述されている場合、正しいパッケージ構造を遵守することを強くお勧めします。 ファイルへのパスを指定する際のsrc属性では、パッケージパッケージングコマンドが実行されるコンテキストで現在のディレクトリから開始する必要があることを理解することが重要です。

NuSpecファイルの準備ができたら、パッケージのトライアル作成を開始できます。 これを行うには、nuget pack MyAssembly.nuspecという単純なNuGet.exeユーティリティコマンドを実行します。



したがって、切望されている「最初のパッケージ」または「プロトタイプパッケージ」、つまりNuGetパッケージマネージャーまたはNuGet.exeを使用してプロジェクトでのインストールに使用できるnupkgファイルを取得する必要があります。

既製パッケージの展示

そのため、何らかの「パッケージ配布チャネル」を通じてユーザーに何らかの形で配信する必要があるパッケージがあります。 ほとんどのユーザーはVisual Studioを介してパッケージをインストールすると考えています。 組み込まれたNuGetパッケージマネージャーは、パッケージを配置するための2つのオプションを理解します。

• ネットワーク経由で利用可能なパッケージギャラリー。
• Windowsフォルダー（ローカルまたはネットワーク）。

設定に独自のパッケージソースを追加できます。パッケージをインストールまたは復元するときに、目的のIDが見つかるまで順番にスキャンされます。 同じ（！）パッケージが複数のソースにある場合のオプションはまったく許容できます。



パッケージを配布する最も簡単なオプションは、ネットワークフォルダーを作成し、そこにパッケージを配置することです。



NuGetを使用すると、パッケージhttps://nuget.orgの一般的なギャラリーだけでなく、独自のギャラリーを作成することもできるため、 https：//nuget.orgで使用されている場所に同じエンジンを展開できます。 。 私たちのチームはこのオプションを好んでいます。この場合、ダウンロード統計を追跡し、サイトを通じて許可を管理することが可能になり、最終的にはとても美しいからです。







ギャラリーの設置には、少なくとも承認の問題において、タンバリンとの小さなダンスが必要になる場合がありますが、それについて複雑なことは何もありません。 パッケージはNuGet.orgと同じ方法で公開されます。ギャラリーサイトを更新するときは、ダウンロード済みのパッケージでアーカイブが失われないようにすることが重要です。それらはサイトディレクトリに保存されます。 この場合、ユーザー用にNuGetパッケージマネージャーを設定すると、次のようになります。







パッケージのローカルソースが、たとえば同じローカルネットワーク上のユーザーに近い場合、依存関係を持つすべてのパッケージをダウンロードすることをお勧めします。これにより、新しいユーザーのパッケージをダウンロードする時間が短縮されます。 依存パッケージからnupkgファイルを見つけるのは非常に簡単です-それらは常にこれらのパッケージがインストールされているパッケージフォルダー（通常はslnファイルがあるディレクトリ）にあります。 また、パッケージソースの設定ウィンドウでは順序が重要です。パッケージが設定で指定された順序で復元されると、スタジオはソースを反復処理します。 したがって、パッケージがローカルでのみ利用可能な場合は、nuget.orgへの不必要な要求がないように、最初にソースを配置します。

NuGet Packet Factory

「プロトタイプパッケージ」が作成され、「パッケージの配布チャネル」が確立されたら、マウスの最初のクリックで最新のNuGetパッケージを取得できるように、パッケージのアセンブリを自動化することができます。



Team Foundation Server 2013/2015の場合、これがどのように行われるかを見てみましょう。 他の同様のCIシステムの場合、プロセスは同様になります。

ビルド定義（XAML）プロパティで、ビルドが成功した場合に実行されるPowerShellスクリプトを指定できます。 このスクリプトで「パッカー」を呼び出し、NuSpecファイルへのパスをパラメーターとして渡します。



自分で明確にする必要があるいくつかのポイントがあります。NuGet.exe自体と必要なすべてのファイル（少なくとも構成ファイル）はどこにあり、NuSpecファイルはどこにありますか？ 一方では、NuGet.exeがビルドサーバー上の特定の場所に配置されるという事実に依存できますが、複数のビルドサーバーがあり、それらを管理する必要がない場合は、NuGet.exeをソース管理に配置し、その場所にディレクトリを追加するのが最も簡単ですビルドが実行されるワークスペースで。 NuSpecについては、slnファイルの隣に置いておくと、ソリューションエクスプローラーからすばやくアクセスできるように、ソリューションアイテムに含めることもできます。



複数のソリューションがあり、複数のパッケージを作成する予定がある場合は、1つの共通のPowerShellスクリプトを実装することをお勧めします。このスクリプトは、NuSpecファイルへのパスをパラメーターとして受け取ります。



以下は、このようなスクリプトからの抜粋です。





スクリプトでは、相対パスを絶対パスに変換する操作が実行されます（スクリプトの実行時にCIシステムによって示される使用可能な変数の説明を簡単に見つけることができます）。 場合によっては、このスクリプト内のNuSpecファイルの変更が必要です。 たとえば、この方法で、さまざまな構成（任意のCPU、x86）のパッケージの作成を処理できます。



実際、これはNuGetパッケージを作成するための自動メカニズムをセットアップします。 ビルドサーバーでアセンブリを開始し、すべてが機能したことを確認します。 デバッグ情報を取得するには、何か問題が発生した場合、ビルド定義設定のスクリプトパラメーターに–Verboseを記述することを忘れないでください。 完成したパッケージを共有リソースまたはギャラリーに注ぎ、最初のユーザーを招待します。

プロセスの微妙さ

彼らが言うように、「プログラマーの主な仕事は完璧主義者を殺すことです」。 内部の完璧主義者がまだgivenめていなければ、次の点が役に立つでしょう。



NuGetパッケージを作成する機能に加えて、各パッケージのビルドサーバーのスクリプトは、コード内のXMLコメントに基づいて自動ドキュメントを生成するユーティリティを実行できます。 この機能は、パッケージの各バージョンに独自のバージョンの自動ドキュメントがあるという意味で便利です。ユーザーが異なるバージョンのNuGetパッケージを使用すると便利です。 Doxygenを使用して自動ドキュメントを生成します 。 自動ドキュメントに関するスクリプトセクションは次のとおりです。





2番目の項目は、異なるバージョンの.netフレームワークの異なるバージョンのアセンブリが1つのパッケージにパッケージ化されている場合、プロジェクトのアセンブリに関係します。



トリックは、ビルドサーバーに.netフレームワークのさまざまなバージョンのアセンブリを強制的にビルドすることから始まります。 新しいjsonプロジェクトファイル形式（ASP.NET5）ではなく、csproj形式でアセンブルされるプロジェクトを検討してください。 Visual Studioは、アセンブリ構成メカニズムをサポートしています。 通常、デバッグとリリースの2つの構成が使用されますが、同じメカニズムにより、.netバージョンの切り替えを構成できます。



独自の構成を作成できます。 残念ながら、必要なすべてのパラメーターを微調整するには、csprojファイルを開いて、少なくとも各構成セクションでTargetFrameworkVersionを設定する必要があります。

Visual Studioの構成は、主にツールバーで切り替えられます;サーバー上のアセンブリ定義では、順番にコンパイルされる複数の構成を一度に選択できます。



.netフレームワークの異なるバージョンのコードが異なる場合は、ディレクティブを使用して処理できることに注意してください：

  #if NETFX_35 for (int i = 0; i < resValueLength; i++) #else System.Threading.Tasks.Parallel.For(0, resValueLength, i => #endif
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

この場合、csprojファイルの対応するセクションで定数を定義する必要があります。

 <DefineConstants>DEBUG;TRACE;NETFX_35</DefineConstants>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

既製のコンパイル済みアセンブリができたら、nuspecを適切に構成する方法を理解しましょう。 Nuspecは、.netフレームワークの特定のバージョン用の特別なディレクトリを定義します。



NuSpecファイルのファイルセクションの例：

  <files> <file src="Debug-Net35\LogService.dll" target="lib\net35\LogService.dll" /> <file src="Debug-Net35\LogService.XML" target="lib\net35\LogService.XML" /> <file src="Debug-Net40\LogService.dll" target="lib\net40\LogService.dll" /> <file src="Debug-Net40\LogService.XML" target="lib\net40\LogService.XML" /> <file src="Debug-Net45\LogService.dll" target="lib\net45\LogService.dll" /> <file src="Debug-Net45\LogService.XML" target="lib\net45\LogService.XML" /> </files>
      
      

        
        
        
      

    
        
        
        
      
      

        
        
        
      

    
     

NuGetパッケージを使用する場合（作成する場合でも）によく発生する別の問題は、1つのプロジェクトを複数のソリューションに接続する問題です。 実際には、csprojファイルでは、アセンブリリンクが特定のdllに配置され、slnファイルの隣にあるパッケージフォルダーのVisual Studioにデフォルトで復元されます。 したがって、同じプロジェクトが異なるフォルダーにある複数のソリューションに含まれている場合に問題が発生します。 この問題を解決するには、ビルド前にリンクを書き換える特別なターゲットを含むNuGetパッケージを使用できます： https : //www.nuget.org/packages/NuGetReferenceHintPathRewrite 。



NuGetパッケージを使用するもう1つの機能は、アセンブリ中のパッケージ回復のトピックです。 事実、しばらくの間Visual Studioには組み込みのパッケージ回復ツールがなかったため、csprojに特別なターゲットが追加され、回復を担当していました。 最新のVisual Studio（2013+）では、これはもはや関係ありません。csprojファイルをクリーンに保ち、NuGetパッケージを復元するためにターゲットは必要ありません。



最後に、TFSを使用する場合、パッケージフォルダーは既定でソース管理にクロールされ、TFSのすべてのアセンブリを定期的に点滅させてチェックできるという事実について説明できます。 これを防ぐために（地獄でTFSのアセンブリを修正する人には別のボイラーがあるはずです） 、. tfignoreファイルを使用できます。

結果

したがって、私たちが提案した指示に記載されているすべてを完了すると、人間の介入なしで機能する既製のパッケージパッケージングメカニズムを取得できます。 パッケージはそのように構築されています。 そうでない場合は、出版物自体に注意が必要です。

便利なリンク：

• NuGetとは
• Nuspecファイル仕様 。
• ユーティリティNuGet.exe ;
• NuGetパッケージエクスプローラー
• トップ10 NuGet（Anti-）パターン ;
• パッケージギャラリーエンジンの配布
• Doxygen Auto Document Generator ;
• プロジェクトの問題をいくつかのソリューションで解決します。
• packagesフォルダーの問題を解決します。これはPending changesに該当します 。