SourcePipeline を使用する

Classic/VPC環境で利用できます。

SourcePipelineサービスが提供するスペックを確認して使用シナリオと用語を十分熟知したら、SourcePipelineの利用を始めるための準備が完了します。次は SourcePipelineを作成してパイプラインプロジェクトを作成します。SourcePipelineの作成、実行と管理は NAVERクラウドプラットフォームで行います。

ユーザー権限

ログインアカウントに応じた SourcePipeline利用権限を確認し、必要に応じてンソールの Services > Management & Governance > Sub Account メニューでサブアカウントの権限を設定します。

• 顧客アカウント: SourcePipelineのすべての機能を制限なしに利用可能
• 顧客が作成したサブアカウント: SourcePipelineを使用するには、以下の権限のうち1つが必要
  • NCP_INFRA_MANAGER : 顧客アカウントと同様に SourcePipelineを含む NAVERクラウドプラットフォーム内のすべてのサービスを利用可能。ただし、 マイページ の一部管理機能を除く。
  • NCP_SOURCE_PIPELINE_MANAGER / NCP_VPC_SOURCE_PIPELINE_MANAGER : SourcePipelineサービス内のすべての機能を利用可能

SourcePipeline作成準備

SourcePipelineを作成と使用するには、まず SourceCommit、SourceBuild、SourceDeploy、Object Storageサービスを利用します。
詳しい使用方法は各サービスのご利用ガイドをご参照ください。

SourcePipeline作成

パイプラインを作成する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. [パイプライン作成] ボタンをクリックして新規パイプラインを作成します。
4. パイプラインの作成画面が表示されたら、以下の手順で行います。
   • 1. 基本設定
   • 2. パイプライン構成
   • 3. 最終確認

1. 基本設定

基本設定情報を入力し、 [次へ] ボタンをクリックします。

• パイプライン名 には英数字、特殊文字(「-」「_」)のみ使用できます。
• パイプラインの説明 は3~500文字で入力します。

2. パイプライン構成

連携するタスクを設定してパイプラインを構成します。

パイプラインの構成画面は次の通りです。

パイプラインを構成する方法は次の通りです。

1. パイプラインの構成画面で [タスク追加] ボタンをクリックします。

2. タスク設定のポップアップで設定情報を入力し、 [確認] ボタンをクリックします。

   • 名前 : タスクの名前は、現在のパイプライン内で固有の名前
   • タイプ : SourceBuildまたは SourceDeployを選択。選択したサービスタイプに応じて表示される入力情報項目が変わる。
   • [SourceBuildを選択した場合]
     • プロジェクト : SourceBuildプロジェクトを選択。選択時に 接続情報 が項目の下に表示される。
     • 接続情報 領域
       • タイプ : SourceBuildプロジェクトの作成時または設定の変更時に、 ビルド対象 項目で選択したタイプ(SourceCommit、Github、Bitbucket、Github Enterprise Server)
       • リポジトリ : 接続されたリポジトリ情報を表示
       • ブランチ : 接続されたリポジトリのブランチ情報を表示。パイプラインの構成に必要なブランチに変更可能。
   • [SourceDeployを選択した場合]
     • プロジェクト : SourceDeployプロジェクトを選択
     • ステージ : 選択した SourceDeployプロジェクトのステージを選択
     • シナリオ : 選択した SourceDeployプロジェクトのシナリオを選択。実行可能なシナリオのみリストに表示される。選択時に 接続情報 が項目の下に表示される。
     • 接続情報 領域
       • タイプ : リリースシナリオの作成時または設定の変更時に、 リリースファイルの保存場所 項目で選択したタイプ(SourceBuild、Object Storage)を表示
       • 情報 : リリースシナリオの リリースファイルの保存場所 項目で選択したタイプに応じて、設定したビルドプロジェクト名または Object Storageパス情報を表示

3. パイプラインの構成画面で未設定領域にあるタスクの中から、設定するタスクの をクリックします。

   • タスクの設定状態を詳細確認するか修正するには、そのタスクの をクリックして設定を確認し、修正します(上記の手順2番を参照)。
   • タスクを削除するには、をクリックしてポップアップで [削除] ボタンをクリックします。

4. 先行タスクの選択ポップアップで先行タスクを選択し、 [確認] ボタンをクリックします。

   • 設定したタスクは右側の設定領域に移動します。
   • 先行タスクなし を選択する場合は1番目のタスクに設定されます。
   • 先行タスクを選択する場合はそのタスクは先行タスクの次のタスクに設定されます。

5. 設定領域でパイプラインがタスク順に合わせて設定されているか確認します。

   • タスクの設定状態を詳細確認するか修正するには、そのタスクの をクリックして設定を確認し、修正します(上記の手順2番を参照)。
   • タスクの順序を変更するには、そのタスクの をクリックして希望する先行タスクを選択し、[確認] ボタンをクリックします。
   • 当該タスクを1番目のタスクに設定するには、選択された先行タスクをクリックして選択を解除し、 先行タスクなし を選択してから [確認] ボタンをクリックします。
   • 設定領域に1番目のタスク( 先行タスクなし と設定されたタスク)が2つ以上ある場合、パイプラインは構成できません。先行タスクを選択してタスクの順序を設定するか、不要な場合は削除してください。
   • タスクを削除するには、そのタスクの をクリックしてポップアップで [削除] ボタンをクリックします。設定領域で削除したタスクはプロジェクトから完全に削除されず、未設定領域に移動します。

6. トリガーイベントを設定するには、 種類 項目のチェックボックスをクリックして選択します。

   • Pushトリガー
     • リポジトリ/ブランチ(SourceCommit)に pushイベントが発生すると、そのパイプラインが自動で実行されます。SourceCommitサービスのコンソール上で、ウェブ編集などのコミット(commit)イベントの発生時にも実行されます。
     • Pushトリガーイベントを追加するには、 Repository 、 Branch 項目で SourceCommitに登録したリポジトリとブランチを選択し、 [追加] ボタンをクリックします。
     • 設定したトリガーイベントを削除するには をクリックしてトリガーリストから削除します。
   • パイプライントリガー
     • トリガー設定されたパイプラインが実行完了すると、そのパイプラインが自動的に実行されます。
     • パイプライントリガーを追加するには、 パイプライン 項目で SourcePipelineに登録したプロジェクトを選択し、 [追加] ボタンをクリックします。
     • 再帰的に構成する場合、パイプラインが連続して実行される可能性があります。
   • 予約トリガー
     • 設定された予約時間に対応するパイプラインが自動的に実行されます。
     • 予約の設定方法は次の通りです。
       *
       1. 予約設定画面で [作成] ボタンをクリックします。
       • 2. 予約登録のポップアップで設定情報を入力し、 [確認] ボタンをクリックします。
         • 繰り返し : 繰り返す曜日を選択します。毎日をクリックすると、すべての曜日が選択されます。
         • 時間 : パイプラインが自動実行される時間を入力します。[HH:mm] 形式で入力でき、選択した TimeZoneに合わせて実行されます。
         • 実行有無 : SourcePipelineを設定する際に、SourceBuildプロジェクト、SourceDeployシナリオに設定した SourceCommitリポジトリに追加したコミットがあるか、SourcePipelineの設定を変更した後に成功した実行がない場合に実行されます。

7. パイプラインの構成が完了したら [次へ] ボタンをクリックします。

3. 最終確認

設定内容を確認し、 [パイプライン作成] ボタンをクリックします。

SourcePipeline画面

パイプラインの基本情報を確認する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. パイプラインリストでパイプラインの基本情報を確認します。

パイプラインリスト画面の各項目についての説明は次の通りです。

トリガーイベント確認

トリガーイベントを確認する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. パイプラインリストで確認対象のパイプライン名にある trigger 列の [見る] ボタンをクリックします。
4. トリガー(Trigger)情報のポップアップで設定したトリガーイベントを確認します。
   • トリガーの追加、修正、削除方法は、SourcePipeline設定変更をご参照ください。

SourcePipeline実行

パイプラインを実行する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。

2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。

3. パイプラインリストで実行対象のパイプライン名をクリックします。

   • または、パイプライン名の左側にあるチェックボックスを選択し、 [パイプラインに移動] ボタンをクリックします。

4. パイプラインタブ 画面でパイプラインの情報と設定を確認します。

• パイプラインを実行する前に、リポジトリのブランチとリリースシナリオを変更できます。ただし、変更された設定は今回のパイプラインの実行にのみ適用されます。

5. SourceBandイシュー関連付け情報を確認します。

6. 今回のパイプライン実行を SourceBandイシューに関連付けるには 関連付け を選択します。

   • 関連付ける SourceBandイシューを選択するには [イシュー選択] ボタンをクリックします。
   • SourceBandイシュー関連付けポップアップで関連付けるイシューを検索して追加します。

7. パイプライン タブ画面で [パイプラインを実行する] ボタンをクリックします。

• パイプラインが実行されると タスク結果 タブに移動し、タスク結果リストにタスクの状態が Ready から Running に変わります。

8. タスク結果 タブ画面で進捗状況を確認します。

• パイプラインの実行中にタスクをキャンセルするには、そのタスクにある [キャンセル] ボタンをクリックします。キャンセルするとタスクの状態が Canceled と表示されます。
• タスクの状態が失敗、キャンセル、エラーの場合、 [再実行] ボタンが表示されます。 [再実行] ボタンは最後に実行したタスクにのみ表示されます。
• タスク結果に関する詳細は、SourcePipelineタスク結果確認をご参照ください。

SourcePipelineタスク結果確認

パイプラインのタスク結果を確認する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. パイプラインリストでタスク結果を確認する対象パイプライン名をクリックします。
   • または、パイプライン名のチェックボックスを選択し、 [パイプラインに移動] ボタンをクリックします。
4. パイプラインの詳細画面で タスク結果 タブをクリックします。
5. パイプラインのタスク結果リストで確認対象のタスクをクリックし、タスク結果を確認します。
   
   • 各タスクの詳細結果を確認するには、をクリックします。SourceBuild、SourceDeployサービスのタスク結果画面に移動します。この場合に SourceBuild、SourceDeployの使用権限がないと、ログの確認が制限される場合があります。
   • タスクの状態が失敗、キャンセル、エラーの場合、SourcePipelineを再実行できます。
   • SourceBuild、SourceDeployの使用方法は各サービスのご利用ガイドをご参照ください。

SourcePipeline再実行

失敗、キャンセル、エラーが発生した最後のパイプラインタスクを再実行できます。
パイプラインのタスク構成を変更しない場合でも再実行できます。

パイプラインを再実行する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. パイプラインリストで再実行対象のパイプライン名をクリックします。
   • または、パイプライン名のチェックボックスを選択し、 [パイプラインに移動] ボタンをクリックします。
4. パイプラインの詳細画面で タスク結果 タブをクリックします。
5. パイプラインのタスク結果リストで [再実行] ボタンをクリックします。
   • タスクの状態が失敗の場合、そのタスクの をクリックしてその SourceBuildまたは SourceDeployサービスのタスク結果画面で失敗の原因を把握し、再設定してから [再実行] ボタンをクリックします。
6. タスクの失敗が続く場合、上記の5番を繰り返して失敗の原因を削除します。

SourcePipeline設定変更

パイプラインの設定を変更する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. パイプラインリストで設定を変更する対象パイプライン名のチェックボックスを選択し、 [設定変更] ボタンをクリックします。
   • 作成したパイプライン名をクリックすると、パイプラインの実行画面に移動します。選択の際はご注意ください。
4. 基本情報 領域でパイプラインの説明を変更します。

• Source Phaseを修正すると、Build/Deploy Phaseが初期化されます。

5. パイプライン構成 、Trigger設定 領域でパイプラインと接続されたタスクとトリガーイベントの設定を変更します。

• 詳細は、SourcePipeline作成の2. SourcePipeline構成のステップをご参照ください。

6. 設定変更を完了し、 [適用] ボタンをクリックします。

SourcePipeline削除

パイプラインを削除する方法は次の通りです。

1. NAVERクラウドプラットフォームコンソールにアクセスします。
2. Services > Developer Tools > SourcePipeline メニューを順にクリックします。
3. パイプラインリストで削除対象のパイプラインを選択し、 [削除] ボタンをクリックします。
   • 作成したパイプライン名をクリックすると、パイプラインの実行画面に移動します。選択の際はご注意ください。
4. パイプラインプロジェクト削除のポップアップで内容を確認し、 [削除] ボタンをクリックします。