Salesforce DX 開発者ガイド
jJenkins の環境の設定
Dev Hub とスクラッチ組織を既存の Jenkins フレームワークに統合する前に Jenkins 環境を設定します。本書の例では、パッケージ開発モデルで作業していることを前提としています。
-
Dev Hub 組織で、JWT ベース認証フローの説明に従って接続アプリケーションを作成します。この手順には、非公開鍵とデジタル証明書の作成または取得が含まれます。
接続アプリケーションの保存時にコンシューマー鍵 (クライアント ID と呼ばれることもある) を書き留めておきます。Jenkins 環境を設定するにはコンシューマー鍵が必要です。また、デジタル証明書の署名に使用する非公開鍵ファイルも用意しておきます。
-
Jenkins サーバーを実行するコンピューターで、次の操作を行います。
- Salesforce CLI をダウンロードしてインストールします。
-
Jenkins ログイン情報管理インターフェースを使用して、非公開鍵ファイルを Jenkins 秘密ファイルとして保存します。新しいエントリの ID を書き留めておきます。
後で Jenkinsfile でこのログイン情報エントリを参照します。
-
Jenkins 環境で次の変数を設定します。
- SF_USERNAME — Dev Hub 組織のユーザー名 (juliet.capulet@myenvhub.com など)。
- SF_INSTANCE_URL — Dev Hub 組織をホストする Salesforce インスタンスのログイン URL。デフォルトは https://login.salesforce.com です。この値は、Dev Hub 組織の [私のドメイン] ログイン URL に更新することをお勧めします。組織の [私のドメイン] ログイン URL は、[設定] の [私のドメイン] ページで確認できます。
- SF_CONSUMER_KEY — Dev Hub 組織で接続アプリケーションを作成した後に返されたコンシューマー鍵。
- SERVER_KEY_CREDENTALS_ID — Jenkins ログイン情報管理インターフェースで保存した非公開鍵ファイルのログイン情報 ID。
- PACKAGE_NAME - パッケージの名前 (My Package など)。
- PACKAGE_VERSION - パッケージのバージョン。04t で始まります。
- TEST_LEVEL - パッケージのテストレベル (RunLocalTests など)。
これらの環境変数の名前はあくまでも目安です。Jenkinsfile で指定すれば、任意の名前を使用できます。必要に応じて、SF_AUTOUPDATE_DISABLE 変数を true に設定して Salesforce CLI の自動更新を無効にすることもできます。CLI の自動更新は、Jenkins ジョブの実行を妨げる場合があります。
- スクラッチ組織を作成できるように Salesforce DX プロジェクトを設定します。
- (省略可能) Custom Tools プラグインを Jenkins コンソールにインストールし、Salesforce CLI を参照するカスタムツールを作成します。Jenkins のウォークスルーでは、/usr/local/bin ディレクトリ (Salesforce CLI がインストールされるディレクトリ) に toolbelt という名前のカスタムツールバーが作成されていることを前提としています。