プロジェクトの設定

学習の目的

  • GitHub リポジトリの用途を説明する。
  • CumulusCI を使用する開発プロジェクトの作成方法を説明する。
メモ

メモ

このモジュールを始める前に、次の先行モジュールの手順を実行してください。

  • CumulusCI の設定

このモジュールや他の「Build Applications with CumulusCI」 (CumulusCI を使用したアプリケーションの構築) トレイルのモジュールでは、必ず Tasha と一緒に手順を実行してください。そうすることで、このトレイルの以降にある手順とハンスオン Challenge のための準備ができます。

このモジュールでは「CumulusCI の設定」モジュールからストーリーを引き継ぎ、コラボレーティブなコミュニティチームが数千もの食料安全保障団体にメリットをもたらす可能性があるオープンソースアプリケーションを開発していきます。このチームは「CumulusCI の設定」で CumulusCI を使用できるように各自のコンピュータを設定し終えており、Salesforce でフードバンクプロジェクトの作成を開始する準備ができています。

Tasha は、Compa Food Security Network の Salesforce システム管理者です。Tasha はすでに Salesforce をカスタマイズしてフードバンクのロジスティックスを管理する方法をブレインストーミングし、その方法を新しい「Food Bank (フードバンク) アプリケーション」に反映する準備ができています。Tasha の大学時代の友人 Maddie は Hunger Northeast という別のフードバンクでロジスティックスを管理しており、アプリケーションから多くのメリットを得られる 1 人です。Tasha の友人で Advocate Partners の開発者兼コンサルタントの Isabel はこのプロジェクトにスキルを提供しています。

Tasha とそのチームが作業に取りかかるには、チーム全体がカスタマイズ作成時に使用できる一元管理されたワークスペースが必要です。このチームは GitHub リポジトリを使用してすべてのカスタマイズを保存する予定なので、CumulusCI ツールを使用できるようにこのリポジトリを設定します。

GitHub リポジトリを作成する

GitHub はプロジェクトでコラボレーションする全員の共有スペースを提供します。また、プロジェクトへの変更を追跡するバージョン管理システム (VCS) として機能し、変更とカスタマイズが保存されます。

GitHub リポジトリを作成する手順は次のとおりです。

  1. GitHub Desktop を開きます。
  2. メニューから [File (ファイル)] → [New Repository (新規リポジトリ)] を選択します。
  3. リポジトリの情報を次のように入力します。
    1. Name (名前): Food-Bank (フードバンク)
    2. Description (説明): Customization of Salesforce for food banks (フードバンクのための Salesforce のカスタマイズ)
    3. Local Path (ローカルパス): GitHub フォルダを選択するか、必要であれば、プロジェクトを保存する新規フォルダを作成します。
    4. Git Ignore: None (なし)
    5. Licence (ライセンス): None (なし)
  4. [Create Repository (リポジトリの作成)] をクリックします。

リポジトリが設定されたので、CumulusCI を使用してオートメーションの設定を開始できます。

プロジェクトに CumulusCI の使用を設定する

プロジェクトの履歴とカスタマイズを保存する GitHub リポジトリを設定したので、次はローカルコンピュータで CumulusCI を使用するようにプロジェクトを設定する必要があります。CumulusCI はチームの全員にカスタマイズ可能なオートメーションを提供してスクラッチ組織に開発またはテスト環境を作成し、プロジェクトの設定手順を自動化できるようにします。

次の手順に従って、CumulusCI を使用するように新しいプロジェクトを設定します。

  1. GitHub Desktop で [Repository (リポジトリ)] → [Open in Visual Studio Code (Visual Studio Code で開く)] を選択して、VS Code でリポジトリを開きます。([Open in Visual Studio Code (Visual Studio Code で開く)] が表示されない場合は、[Open in External Editor (外部エディタで開く)] を選択するか、GitHub Desktop を閉じてから再度開いて更新してください)。
メモ

メモ

Git が見つからないことを示すメッセージはすべて無視してください。このプロジェクトのターミナルから Git を使用することはありません。

  1. VS Code で [Terminal (ターミナル)] → [New Terminal (新規ターミナル)] を選択して新しいターミナルを開きます。
  2. ターミナルウィンドウで cci project init コマンドを入力します。
メモ

メモ

「You are not in the root of a Git repository」 (Git リポジトリのルートではありません) というエラーが表示された場合、GitHub Desktop のリポジトリビューアから VS Code を開いていることを確認してください。

  1. プロジェクトの情報を求める一連の指示に次のように答えます。
    1. Project Name (プロジェクト名): Return キーを押します。これにより、前に設定したデフォルトのプロジェクト名 (Food-Bank) が受け入れられます。
    2. Package Name (パッケージ名): Food-Bank であることを確認します。
    3. Managed package project (管理パッケージプロジェクト): n
    4. Salesforce API Version (Salesforce API バージョン): Return キーを押してデフォルトを受け入れます。
    5. Source format (ソース形式): sfdx
    6. We’re not extending another project (別のプロジェクトの拡張ではない): n
    7. 残りのすべての質問では Return キーを押してデフォルトを受け入れます。

この手順を完了すると、VS Code ターミナルに「Your project is now initialized for use with CumulusCI」 (プロジェクトは CumulusCI を使用するために初期化されました) と表示されます。

  1. VS Code ターミナルに cci service connect devhub --project コマンドを入力します。
  2. ユーザ名の入力を促されたら、CCIDevHub と入力して Return キーを押します。

これにより、このプロジェクトでスクラッチ組織の作成を要求すると、このトレイル用に作成した特別な Dev Hub 組織を CumulusCI が使用するように設定されます。

設定を GitHub にコミットする

CumulusCI がローカルコンピュータのプロジェクトで機能するように設定されました。次は、設定を GitHub 中央リポジトリにコミットしてチームと共有しましょう。

まず、設定をプロジェクトのメインブランチにコミットして GitHub に送れるようにします。

  1. GitHub Desktop を開き、[Current Repository (現在のリポジトリ)] で Food-Bank リポジトリが選択されていることを確認します。
  2. 画面左側に変更されたファイルのリストが表示されます。すべてのファイルが選択されている必要があります。
    画面の左側に変更されたファイルのリストが表示されている GitHub インターフェース
  3. 左下の [Summary (概要)] 項目に「Set up project」 (プロジェクトの設定) など、変更の短い概要を入力します。
  4. [Commit to main (メインにコミット)] をクリックします。

次に、作業内容を GitHub に公開してチームメンバーが自分とコラボレーションできるようにします。

  1. 画面の右側で [Publish this repository to GitHub (このリポジトリを GitHub に公開する)] セクションを見つけ、[Publish repository (リポジトリを公開)] をクリックします。これはテストプロジェクトであるため、[Keep this code private (このコードを非公開に保つ)] を選択して他の GitHub ユーザに作業内容を表示しないようにすることもできます。これは他のフードバンクとコラボレーションするオープンソースプロジェクトであるため、Tasha はリポジトリをオープン (公開) にします。
  2. [Publish Repository (リポジトリを公開)] をクリックします。
  3. プロセスが完了したら、右側のペインで [View on GitHub (GitHub で表示)] をクリックして Web ブラウザで GitHub リポジトリを開き、次のセクションではそこで作業できるようにします。

これで Tasha、Maddie、Isabel は共有スペースに検討内容や作業内容を集め、熱意をもってプロジェクトを実現していくことができます。

リソース