Visual Basic 中学校 > 雑記 >

NuGetでパッケージを公開する

2021/4/25

この記事が対象とする製品・バージョン

	Visual Studio 2019	◎	対象です。
	Visual Studio 2017	×	対象外です。
	Visual Studio 2015	×	対象外です。
	Visual Studio 2013	×	対象外です。
	Visual Studio 2012	×	対象外です。
	Visual Studio 2010	×	対象外です。
	Visual Studio 2008	×	対象外です。
	Visual Studio 2005	×	対象外です。
	Visual Studio 2003	×	対象外です。
	Visual Studio (2002)	×	対象外です。

１．概要

自作のプログラムを NuGet で公開する方法を説明します。

NuGetで公開すると世界中のユーザーがVisual Studioなどを使って「パッケージ」としてあなたのプログラムを使用できるようになります。

この記事では、私が Umyadia.Database.HistoricalTimeline というパッケージを実際に NuGet で公開した時のやりかたになぞって説明します。

私はこの記事の内容を下記の環境で実施しました。環境が異なる場合画面や操作方法が大きく異なる場合があります。

• Visual Studio 2019 (16.9.3)
• Windows 10
• 対象のプロジェクトは .NET 5 のクラスライブラリ

参考

.NET Standard NuGet パッケージの作成と公開 - Windows 上の Visual Studio | Microsoft Docs

２．プログラム作成

まずは公開するプログラムを作成します。既に作成済みのプログラムを利用することもできます。

プロジェクトの種類は クラスライブラリ にします。

一度 NuGet で公開すると修正はできません。十分にテストしてください。

※新しいバージョンを公開したり、公開を停止したりすることはできます。

テストが完了したら次のステップに進みます。

３．パッケージ情報を設定

３－１．ライセンス情報

NuGetで公開するためにライセンス情報が必須です。

他のユーザーにどのような条件で使用を許諾するかライセンスを設定します。

そのために、ソリューションエクスプローラーでプロジェクトを右クリックし、プロパティ画面を表示します。

プロパティ画面では、パッケージページのライセンスの式欄でライセンスを設定します。

次のような値を指定できます。

※法律的な詳細を含むと説明が複雑になるのでここでは概要だけ紹介します。詳しくは自分で調べてください。この記事はここで記述する内容について何の法的保証もしません。

指定可能な値の一覧は下記を参照してください。

https://spdx.org/licenses/

※ライセンスはファイルを指定することもできるようです。

３－２．その他の情報

その他に必須ではありませんが、下記の情報を設定できるようです。

これらの項目はVisual Studioから使うNuGetパッケージマネージャーやWebブラウザーでNuGetのパッケージを表示・検索するときに使用されます。

これらの項目がどのように設定されているかアップロード時に確認画面に表示されます。

いくつか私には設定方法がわからない項目もあります。

参考：NuGetターゲットとしてのパックと復元 MSBuild | Microsoft Docs

設定方法が「プロジェクトファイルの」となっているものは、プロジェクトファイル(拡張子がcsproj または vbproj のファイルなど)を直接編集して設定できます。Visual Studioのソリューションエクスプローラーでプロジェクトをダブルクリックするのが楽です。Visual Studioではなくメモ帳等で編集してもOKです。プロジェクトファイルは XML形式になっており、書き込む場所は <Project> - <PropertyGroup> の直下です。

上の表で 「パッケージページの」となっているものも、結局はプロジェクトファイルの同じ場所に書き込まれます。

たとえば、次のようになります。

<Project Sdk="Microsoft.NET.Sdk">

    <PropertyGroup>
        <TargetFramework>net5.0</TargetFramework>
        <PackageLicenseExpression>MIT</PackageLicenseExpression>
        <Title>Umayadia.Database.HistoricalTimeline</Title>
        <GeneratePackageOnBuild>false</GeneratePackageOnBuild>
        <PackageId>Umayadia.Database.HistoricalTimeline</PackageId>
        <Version>1.0.1</Version>
        <Authors>rucio</Authors>
        <Company>Umayadia</Company>
        <Product>Umayadia.Database.HistoricalTimeline</Product>
        <Description>Utility functions to use xxxx.</Description>
        <Summary>Utility functions to use xxxx.</Summary>
        <Copyright>Copyright © rucio 2021</Copyright>
        <PackageProjectUrl>https://www.umayadia.com/main/main.htm</PackageProjectUrl>
        <RepositoryUrl>https://github.com/xxx/xxx</RepositoryUrl>
        <RepositoryType>git</RepositoryType>
        <PackageTags>Web,Convert</PackageTags>
        <PackageReleaseNotes>https://www.umayadia.com/main/main.htm</PackageReleaseNotes>
        <NeutralLanguage>en-US</NeutralLanguage>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <FileVersion>1.0.0.0</FileVersion>
    </PropertyGroup>

</Project>

４．パッケージ作成

ソリューションの構成を Release にして、対象のクラスライブラリを右クリックして パック を選択します。

プロジェクトの bin\Relese フォルダーに拡張子 nupkg のファイルが作成されます。

これが NuGet にアップロードするパッケージの本体です。

５．パッケージのアップロード

５－１．NuGet にサインイン

ブラウザーで NuGet の Webサイトにアクセスします。

https://www.nuget.org/

画面上部にある Upload をクリックします。

※画面の横幅が狭いと、Uplaod は表示されなくなります。この場合は、右上の 三 をクリックします。

マイクロソフトアカウントでのサインインを求められるので、サインインします。

アカウントを持っていない場合は作成します。

５－２．二要素認証の有効化

Enable 2FA for NuGet.org をクリックし、二要素認証を有効化します。

この画面が表示されない場合は、ユーザー名をクリックし、メニューの Account Settings をクリックし、 Login Account で「Two-factor authentication is currently disabled」と書いてある右の「Enable」ボタンをクリックして有効化します。

５－３．アップロード

画面上部の Upload のリンク または、ユーザー名をクリックして表示されるメニューの Upload Package をクリックします。

Browseボタンをクリックして、先ほど Visual Studio の パック で作成した nupkg ファイルを指定します。

アップロードが完了すると、パッケージに含まれる情報が表示されるので確認します。

何か問題がある場合は目立つように問題が表示されます。

なお、私は Summary を指定しているつもりなので Summary は指定されていないという表示になりました。

５－４．説明の記載

この画面の下の方にパッケージの説明文を入力できる箇所がありますので、概要やサンプルコードなどを記載します。

この説明文はアップロード後に入力・変更することもできます。

Custom を選択して Markdown形式で説明文を入力するか、説明が記載されているURL・ファイルが指定できます。

５－５．決定

確認して問題がなければ 下にある Submit ボタンをクリックします。

NuGetによって自動的に内容が検証されます。

悪意のあるプログラムだったりウィルスが混入していないかなどを検証しているのだと思います。検証には数分かかります。

2,3分して、ブラウザーの更新ボタンをクリックすると Status が Listed になりましたが、ページ上部には次の警告が表示されました。

さらに2分くらいすると、うまく警告が消えていました。

６．完了

Visual Studio で NuGet で検索するとちゃんとヒットしました。すばらしいですね。