1. Sitecoreコンテンツのシリアル化

チュートリアル: NuGetとnpmを使用したシリアル化

Version:
日本語翻訳に関する免責事項

このページの翻訳はAIによって自動的に行われました。可能な限り正確な翻訳を心掛けていますが、原文と異なる表現や解釈が含まれる場合があります。正確で公式な情報については、必ず英語の原文をご参照ください。

パッケージ参照 (NuGetやnpm) を使用して、シリアル化された項目をソリューションにインポートできます。

このチュートリアルでは、次の方法について説明します。

  • パッケージを作成する

  • NuGetパッケージを作成する

  • npmパッケージを作成する

  • パッケージ参照を追加する

パッケージを作成する

Sitecoreシリアル化を含むパッケージを作成するには:

  1. パッケージルートにsitecore.jsonファイルを追加します。このファイルには、シリアル化モジュール ファイルを指すmodulesプロパティが含まれています。

    メモ

    モジュール ファイルは、さまざまなパターンに対応するために、パッケージ内で特定の方法で編成されていません。

    パッケージ構造の例:

    • 根

      • sitecore.json

      • modules

    sitecore.jsonファイルの例を次に示します。

    {
  "modules": [
    "modules/*.module.json"
  ]
}

    Sitecore.DevEx.NuGetResourcesExample.module.jsonという名前のモジュールファイルの例:

    {
  "namespace": "Sitecore.DevEx.NuGetResourcesExample",
  "description": "Content serialization example",
  "items": {
    "includes": [
      {
        "name": "Content",
        "path": "/sitecore/content/home"
      }
    ]
  }
}

  2. パッケージが正しく設定されていることを確認するには、次のコマンドを実行します。

    dotnet sitecore serialization info

    コマンドが次のメッセージを返した場合は、パッケージを正常にセットアップします。

    Sitecore.DevEx.NuGetResourcesExample
Content serialization example
  Subtrees:
    Content: /sitecore/content/home

NuGetパッケージを作成する

パッケージルートにsitecore.jsonファイルを追加した後、NuGetパッケージを作成できます。

Sitecoreリソースを含むNuGetパッケージを作成するには、次の手順に従います。

  1. パッケージを定義するために、PackageName.nuspecファイルを追加します。たとえば、次のようにします。

    <?xml version="1.0"?>
<package >
  <metadata>
    <id>NugetResourcesExample</id>
    <description>Example NuGet package containing Sitecore resources</description>
    <authors>Sitecore</authors>
    <version>1.0.0</version>
  </metadata>
  <files>
    <!-- the sitecore.json and modules and items must be copied to the package -->
    <file src="NuGetResourcesExample\sitecore.json" target="" />
    <file src="NuGetResourcesExample\sitecore\**" target="sitecore" />
  </files>
</package>
    手記

    プロジェクト内のPackageName.nuspecファイルに対して特定の場所はありません (ファイル パスが相対的である限り)。

  2. パッケージ化するSitecoreリソースファイル (モジュールファイルまたはシリアル化されたアイテム) をPackageName.nuspecファイルのfilesセクションに追加します。

  3. パッケージをビルドするには、nuget packを実行し、選択したNuGetフィードにプッシュします。

npmパッケージを作成する

パッケージルートにsitecore.jsonファイルを追加したら、npmパッケージを作成できます。

Sitecoreリソースを含むnpmパッケージを作成するには:

  1. パッケージを定義するために、package.jsonファイルを追加します。たとえば、次のようにします。

    {
  "name": "npm-example-package",
  "version": "1.0.0",
  "description": "Sample of providing SIC resources via npm"
}

  2. .gitignoreファイルまたは.npmignoreファイルを開いて、npmパッケージに自動的に含めるリソースが無視されていないことを確認します。

手記

ほとんどのnpmパッケージは、選択したパッケージリポジトリに公開する前にビルドする必要はありません。

パッケージ参照を追加する

大事な

パッケージ参照を使用するには、Sitecore CLI操作中にパッケージをインストールするためのPATHコマンドとしてnugetまたはnpmを使用できる必要があります。

ソリューションにパッケージ参照を追加するには:

  • sitecore.jsonファイルのmodulesプロパティに、次のいずれかのエントリを追加します。

    • nuget:<packagename>

    • npm:<packagename>

    例えば：

    "modules": [
  "local-file-modules/*.module.json",
  "npm:my-package",
  "npm:[email protected]", // version specs allowed per npm install
  "npm:./path/to/local/package", // local package on filesystem
  "nuget:Organization.MyPackage",
  "nuget:[email protected]", // version specs allowed. No wildcards.
],
    手記

    NuGetパッケージ参照は、登録済みのパッケージ ソースを使用してコンピューターにインストールします。カスタム パッケージ ソースを指定するには、リポジトリのルートに、パッケージ参照を解決するためのカスタム フィードを含むNuGet.configファイルを作成します。

    詳細については、「 NuGetを使用したコマンド ライン インターフェイスの拡張」を参照してください。

パッケージ参照が登録されると、モジュールを使用するSitecore CLI操作中に、パッケージ参照が自動的にインストールされ、モジュールが解析されます。モジュールの取り付けはsitecore ser infoまたはsitecore ser pushで確認できます。モジュールの更新は、どのバージョンの仕様にもとづいて自動的に行われます。

この記事を改善するための提案がある場合は、 お知らせください!