はじめに
はじめまして、エンジニアの小林です。
この記事では、私が実際のプロジェクトにて使用した、リリース管理ツール”Flosum”でのリリース方法を4つのステップでご紹介いたします!
(本記事は開発組織とリリース先組織が既にFlosum<EE組織>へ登録されていることが前提となります)
Flosumが導入されているプロジェクトの方や、Flosumを検討されている方の参考になれば幸いです。
なお、Flosumについて詳しく知りたい方は、以下の記事をご覧下さい。
この記事では、私が実際のプロジェクトにて使用した、リリース管理ツール”Flosum”でのリリース方法を4つのステップでご紹介いたします!
(本記事は開発組織とリリース先組織が既にFlosum<EE組織>へ登録されていることが前提となります)
Flosumが導入されているプロジェクトの方や、Flosumを検討されている方の参考になれば幸いです。
なお、Flosumについて詳しく知りたい方は、以下の記事をご覧下さい。
ステップ① スナップショット作成
最初のステップは、スナップショットを作成します。
スナップショットとは、開発組織から取得した設定や開発情報(以下、リリース資材)を格納するレコードのことです。
では、実際にスナップショットを作っていきましょう。
まず、Orgタブから開発組織を選択し、遷移した開発組織のレコードページ上にある「Create Snapshot」ボタンをクリックします。
スナップショットとは、開発組織から取得した設定や開発情報(以下、リリース資材)を格納するレコードのことです。
では、実際にスナップショットを作っていきましょう。
まず、Orgタブから開発組織を選択し、遷移した開発組織のレコードページ上にある「Create Snapshot」ボタンをクリックします。
スナップショット作成ページへ遷移したら、取得したいリリース資材の条件を指定してスナップショットへ格納します。
条件の指定は主に以下の4つをAND条件で組み合わせて行います。
・更新日付(Retrieve changes in the last):現時点から何日前に更新された設定であるか
・更新者(Changed By):最終更新者は誰であるか
・コンポーネントタイプ(Component Type):コンポーネントタイプは何か
・コンポーネント名(Component Name):コンポーネント名は何か(個人的にはほぼ使わない)
※更新者、コンポーネントタイプ、コンポーネント名については、それぞれコンマ区切りで記入することによりOR条件での指定も可能。
例えば、以下の画像で指定している条件であれば、「最終更新日が14日以内」かつ「最終更新者が”田中一郎”または”田中次郎”」かつ「コンポーネントタイプがカスタム項目」となります。
条件の指定は主に以下の4つをAND条件で組み合わせて行います。
・更新日付(Retrieve changes in the last):現時点から何日前に更新された設定であるか
・更新者(Changed By):最終更新者は誰であるか
・コンポーネントタイプ(Component Type):コンポーネントタイプは何か
・コンポーネント名(Component Name):コンポーネント名は何か(個人的にはほぼ使わない)
※更新者、コンポーネントタイプ、コンポーネント名については、それぞれコンマ区切りで記入することによりOR条件での指定も可能。
例えば、以下の画像で指定している条件であれば、「最終更新日が14日以内」かつ「最終更新者が”田中一郎”または”田中次郎”」かつ「コンポーネントタイプがカスタム項目」となります。
条件を指定した後は、右上の「Create Snapshot」ボタンをクリックしてスナップショットの作成完了となります。
ステップ② ブランチ作成
ステップ②ではステップ①で作成したスナップショットを新規ブランチへ格納します。
ブランチは、機能ごとに取得したスナップショットをまとめたり、複数組織にて開発作業を行っているプロジェクトであれば、開発組織ごとにスナップショットを作成して、それを1つのブランチにまとめたりするというような活用方法も可能です。
では作成していきましょう。
最初に、ステップ①で作成したスナップショットの画面を開き、右上に配置されている「Commit to Branch」ボタンをクリックします。
ブランチは、機能ごとに取得したスナップショットをまとめたり、複数組織にて開発作業を行っているプロジェクトであれば、開発組織ごとにスナップショットを作成して、それを1つのブランチにまとめたりするというような活用方法も可能です。
では作成していきましょう。
最初に、ステップ①で作成したスナップショットの画面を開き、右上に配置されている「Commit to Branch」ボタンをクリックします。
すると、以下のようなブランチ作成画面へ遷移します。
ここでは、スナップショット内の資材からリリースに必要な資材のみをブランチへ格納していきます。
まずは、”Branch Name”にて新規作成するブランチ名を記入します。(既存のブランチへ格納する場合は”Commit to Branch”よりブランチを選択)
次に、”Components”からリリースする資材を選択していきます。
その際、コンポーネントタイプとAPI名などでソートが可能となります。
リリースに必要なすべてのコンポーネントを選択した後は「Continue Commit to Branch」ボタンをクリックします。
ここでは、スナップショット内の資材からリリースに必要な資材のみをブランチへ格納していきます。
まずは、”Branch Name”にて新規作成するブランチ名を記入します。(既存のブランチへ格納する場合は”Commit to Branch”よりブランチを選択)
次に、”Components”からリリースする資材を選択していきます。
その際、コンポーネントタイプとAPI名などでソートが可能となります。
リリースに必要なすべてのコンポーネントを選択した後は「Continue Commit to Branch」ボタンをクリックします。
ボタンクリック後の画面では、選択したコンポーネントが正常に格納可能かどうかが以下の3つに分類されて表示されます。
・Components that have conflicts:既存ブランチに同じコンポーネントが存在している
・Components that are safe to commit:正常にブランチへ格納可能
・Components that will not be committed:何らかの原因によりブランチへ格納不可
すべてのコンポーネントが「Components that are safe to commit」であれば問題なく格納可能なため、再度すべてのコンポーネントを選択し、「Continue Commit to Branch」ボタンをクリックしてブランチ作成完了となります。
・Components that have conflicts:既存ブランチに同じコンポーネントが存在している
・Components that are safe to commit:正常にブランチへ格納可能
・Components that will not be committed:何らかの原因によりブランチへ格納不可
すべてのコンポーネントが「Components that are safe to commit」であれば問題なく格納可能なため、再度すべてのコンポーネントを選択し、「Continue Commit to Branch」ボタンをクリックしてブランチ作成完了となります。
変更セットでのリリースを経験している方はわかると思いますが、リリース作業の中でコンポーネントの選択作業は結構な時間を要してしまいます。
しかし、Flosumであればソート機能のおかげでかなりの作業効率を図ることができます!
しかし、Flosumであればソート機能のおかげでかなりの作業効率を図ることができます!
ステップ③ プロファイル取得
ステップ③は、プロファイルのリリースが必要な場合にのみ実施します。
プロファイルの取得は、「Get Profile」機能を使用することにより、ブランチ内に格納したリリース資材に関連するプロファイルの設定のみをリリースすることが可能となります。
では早速「Get Profile」でブランチへプロファイルを格納していきましょう。
ステップ②で作成したブランチの画面上にある「Get Profile」ボタンをクリックします。
プロファイルの取得は、「Get Profile」機能を使用することにより、ブランチ内に格納したリリース資材に関連するプロファイルの設定のみをリリースすることが可能となります。
では早速「Get Profile」でブランチへプロファイルを格納していきましょう。
ステップ②で作成したブランチの画面上にある「Get Profile」ボタンをクリックします。
プロファイル取得画面へ遷移したら、”Org”より対象の開発組織を選び、リリース対象のプロファイルを選択した後、右上の「Get Profile」ボタンをクリックすればプロファイルの取得完了です。
私自身、過去に変更セットでプロファイルのリリースを行った際に予期せぬ設定が反映されてしまったという苦い経験があるため、必要な設定のみリリースできるこの機能はとても重宝しました!
ステップ④ 検証&デプロイ実施
最後のステップでは検証とデプロイを行います。
流れとしては検証作業を実施し問題がなければ、デプロイを行いリリース完了となります。
では検証作業から行っていきます。
ステップ②で作成したブランチ画面上にある「Validate」ボタンをクリックし以下の検証画面へ遷移したら、"Target Salesforce Organisation"でリリース組織を選択し、「Validate」ボタンをクリックで検証を開始します。
流れとしては検証作業を実施し問題がなければ、デプロイを行いリリース完了となります。
では検証作業から行っていきます。
ステップ②で作成したブランチ画面上にある「Validate」ボタンをクリックし以下の検証画面へ遷移したら、"Target Salesforce Organisation"でリリース組織を選択し、「Validate」ボタンをクリックで検証を開始します。
その後ブランチ画面へ戻り、"Deployment History"の履歴レコードに”Success”と表示されれば検証成功となります。
検証が成功したら、最後にデプロイを行います。
検証時と同じ要領で「Deploy」ボタンからデプロイを実施し、"Deployment History"の履歴レコードに”Success”と表示されればデプロイ成功となり、リリース作業完了です。
検証時と同じ要領で「Deploy」ボタンからデプロイを実施し、"Deployment History"の履歴レコードに”Success”と表示されればデプロイ成功となり、リリース作業完了です。
もし、検証またはデプロイ作業が何らかの原因で失敗した場合は、Flosumからでもエラー内容の確認は可能ですが文字化けしてしまう恐れがあるため、リリース先の組織の「リリース状況」からエラー内容を確認することをおすすめします。
以上、Flosumによるリリース方法のご紹介でした!
実際にFlosumでのリリースを経験すると、リリース資材のソート機能や、複数組織間のリリース資材の一括リリースなど、他にもさまざまな機能が備わっており、非常に快適かつ時間効率を上げることができました!
ご検討されている方はぜひ導入してみてはいかがでしょうか!?
最後までお読みいただきありがとうございました。
実際にFlosumでのリリースを経験すると、リリース資材のソート機能や、複数組織間のリリース資材の一括リリースなど、他にもさまざまな機能が備わっており、非常に快適かつ時間効率を上げることができました!
ご検討されている方はぜひ導入してみてはいかがでしょうか!?
最後までお読みいただきありがとうございました。
35 件