Salesforce DX の設定

学習の目的

この単元を完了すると、次のことができるようになります。

従来の組織開発とモジュール形式のパッケージ開発の違いを説明する。
パッケージの主要な特性を説明する。

ソース駆動型開発の開始

Salesforce DX により、開発ライフサイクル全体を合理化する新しいツールが追加されます。Salesforce DX によって、チーム開発とコラボレーションが向上し、自動テストと継続的インテグレーションが促進され、リリースサイクルがより効率的で俊敏になります。

けれども、Salesforce DX は新たなツールセットというだけではありません。変更セットを開発する代替的な手法であり、信頼できるソースを組織からバージョン管理システム (VCS) に移します。Salesforce DX によって、開発の焦点が、組織の開発からパッケージの開発へと移行します。既存の開発プロセスをパッケージ開発モデルに移行する方法については、「パッケージ開発モデル」モジュールを参照してください。

さて、説明はこれぐらいにしましょう。実際に試してみる準備はできていますか? 環境の設定を開始して、いくつかの新しいツールやお馴染みのツールを紹介しましょう。

スクラッチ組織とは

さまざまな新しいツールで、スクラッチ組織という新種の組織を使用できるようになります。スクラッチ組織は、専用の設定可能な短期間の Salesforce 環境です。スクラッチ組織は、開発プロセスでの開発者の生産性とコラボレーションを促進し、自動テストと継続的なインテグレーションを容易にします。CLI または VS Code 向け Salesforce 拡張機能を使用して、ブラウザでログインせずにスクラッチ組織を開くことができます。次の場合は、新規スクラッチ組織を作成できます。

新しいプロジェクトを開始する。
新しい機能ブランチを開始する。
新しい機能をテストする。
自動テストを開始する。
組織内で直接、開発作業を実行する。
新しい組織でゼロから始める。

スクラッチ組織は、使い捨てることを意図したものですが、スクラッチ組織の設定ファイルは強力です。設定ファイルによって、スクラッチ組織にさまざまな Salesforce エディションを設定でき、必要な機能や設定のみを使用できます。さらに、スクラッチ組織の設定ファイルを他のチームメンバーと共有できます。そうすることで、開発を行うための同じ基本組織を全員が持つことができます。

スクラッチ組織は Sandbox に代わるものか?

違います。スクラッチ組織は Sandbox や本番組織の複製であることを意図するものではありません。その一時的な性質から (有効期限が最大 30 日)、スクラッチ組織は特に新機能、カスタマイズ、パッケージなどの開発に適しています。また、単体テストや継続的インテグレーションにも役立ちます。本番組織のメタデータを完備する Sandbox は、最終的なユーザ受け入れテスト、継続的配信、ステージングなどに必要です。

ここまでは問題ないですね。学習を続けましょう。

Dev Hub を有効化する

Dev Hub では、あなたやそのチームがスクラッチ組織を作成して管理することができます。スクラッチ組織は一時的な Salesforce 環境であり、この新しいソース駆動型開発パラダイムの開発作業の大半をここで行います。

スクラッチ組織の使用を開始するには、Dev Hub として機能する組織を選択します。Dev Hub は任意の有料組織で有効にできますが、本番組織以外の組織を使用することをお勧めします。ここでは、Developer Edition の Dev Hub、またはこのモジュールで使用する Trailhead Playground を有効にします。

任意の有料組織を Dev Hub にして開発者にアクセス権を付与することもできます。詳細は、『Salesforce CLI Setup Guide (Salesforce CLI 設定ガイド)』を参照してください。

これで Dev Hub 組織が準備できたので、次は、その他の Salesforce DX ツールを設定しましょう。

コマンドラインインターフェース (CLI) のインストール

Salesforce CLI を使用することで、アプリケーションのアプリケーションライフサイクル全体を制御できます。開発とテストのための環境の作成、組織と VCS の間でのソースコードの同期、テストの実行を簡単に行うことができます。

メモ

インストールの詳細な手順は、『Salesforce CLI Setup Guide (Salesforce CLI 設定ガイド)』を参照してください。

CLI をインストールします。

OS	インストーラへのリンク
macOS	https://sfdc.co/sfdx_cli_osx
Windows 32 ビット版	https://sfdc.co/sfdx_cli_win
Windows 64 ビット版	https://sfdc.co/sfdx_cli_win64
Debian/Ubuntu 64	https://sfdc.co/sfdx_cli_linux マニフェスト内の URL のいずれかからアーカイブをダウンロードし、アーカイブを抽出し、./install スクリプトを実行します。
Debian/Ubuntu x86	https://sfdc.co/sfdx_cli_linux_x86 マニフェスト内の URL のいずれかからアーカイブをダウンロードし、アーカイブを抽出し、./install スクリプトを実行します。

CLI が適切にインストールされていることと、コマンドのオンライヘルプへのアクセス方法を確認しましょう。

コマンドウィンドウに sfdx と入力します。次のようなページが表示されます。

Salesforce CLI
VERSION
  sfdx-cli/7.75.0-5521f40d11 darwin-x64 node-v12.18.3
USAGE
  $ sfdx [COMMAND]
TOPICS
  alias             manage username aliases
  auth              authorize an org for use with the Salesforce CLI
  config            configure the Salesforce CLI
  force             tools for the Salesforce developer
  plugins           add/remove/create CLI plug-ins
COMMANDS
  autocomplete  display autocomplete installation instructions
  commands      list all the commands
  help          display help for sfdx
  plugins       list installed plugins
  update        update the sfdx CLI
  which         show which plugin a command is in

メモ

このような種類の応答が表示されなかった場合は、sfdx update と入力して、Salesforce DX プラグインと CLI を最新のものにします。

その他に、使用を開始するときには、次のようなコマンドが役立ちます。

コマンド	表示内容
`sfdx force --help`	`force` 名前空間にある参照できるすべてのトピック
`sfdx commands`	使用できるすべてのコマンド

順調に進んでいます。次は、残りの Salesforce DX ツールをインストールしましょう。

Dev Hub へのログイン

初めに、CLI を使用して Dev Hub にログインすると、スクラッチ組織を作成する権限が認められます。sfdx auth:web:login を使用してさまざまな組織にログインできます。組織の管理に役立つオプションもいくつかあります。

どのコマンドでもヘルプを表示できます。ヘルプには、コマンドが実行する内容、各パラメータの説明、パラメータの短いバージョンと長いバージョンのリストが表示されます。最初に実行するコマンドのヘルプを表示する方法を次に示します。

sfdx auth:web:login -h
sfdx auth:web:login --help

Dev Hub を承認するには、Web ログインフローを使用します。
```
sfdx auth:web:login -d -a DevHub
```
-D フラグを追加すると、この組織がデフォルトの Dev Hub として設定されます。-a フラグを使用すると、組織の別名 (DevHub のような覚えやすい名前) を設定できます。別名は、一意の Dev Hub ユーザ名より覚えるのが簡単です。 重要: Dev Hub にのみ -d フラグを指定します。別の組織に使用すると、config:set コマンドを使用して Dev Hub 組織を正しく指定するまでスクラッチ組織を作成できません。
自分のログイン情報でログインします。

成功したら、CLI でトークンが組織の別名と共に安全に保存されます。この例では組織の別名は DevHub です。Dev Hub 組織は、いつでも閉じることができます。

Dev Hub を閉じてもスクラッチ組織を作成できます。有効なスクラッチ組織や名前空間レジストリを参照するために Dev Hub 組織を開く場合は、別名が便利です。

sfdx force:org:open -u DevHub

その他の組織管理機能

あなたはおそらく、Sandbox や本番組織を含め、多くの組織をお持ちでしょう。CLI で次のコマンドを使用して、それらにログインすることもできます。CLI を使用して組織にログインすると、その組織はそれ以降に CLI が作業できる組織のリストに追加されます。

Sandbox へのログイン

Sandbox の別名を作成すると (-a フラグ)、長く、直感的でないことが多いユーザ名の代わりにこの別名によって Sandbox を参照できます。

次に例を示します。

sfdx auth:web:login -r https://test.salesforce.com -a FullSandbox
sfdx auth:web:login -r https://test.salesforce.com -a DevSandbox

重要

-d フラグは使用しないでください。使用してしまうと、CLI がこの組織を Dev Hub とみなし、スクラッチ組織を作成しようとしたときにエラーが表示されます。

別名指定の効果

お察しのとおり、別名指定は組織を管理し、追跡するための強力な方法で、ベストプラクティスであると考えられています。なぜでしょうか? 例として、スクラッチ組織のユーザ名を見てみましょう。スクラッチ組織のユーザ名は、「test-7emx29rtpx0y@example.com」のようになります。覚えるのは簡単ではありません。そのため、組織のユーザ名を必要とするコマンドを実行するときには、覚えやすい組織の別名を使用することで、スピードアップを図ることができます。

sfdx force:org:open -u FullSandbox
sfdx force:org:open -u MyScratchOrg
sfdx force:limits:api:display -u DevSandbox

すべての組織の表示

任意の時点で、sfdx force:org:list コマンドを実行すると、ログインしたすべての組織が表示されます。--verbose オプションを追加すると、さらに多くの情報が表示されます。

これで本当に開始する準備が整いました。Salesforce CLI とスクラッチ組織を使用して新しいアプリケーションを作成しましょう。

トピック