GitHub バージョン 1 のソースアクションを GitHub バージョン 2 のソースアクションに更新する

では AWS CodePipeline、 GitHub ソースアクションには次の 2 つのサポートされているバージョンがあります。

• 推奨： GitHub バージョン 2 アクションでは、CodeStarSourceConnection Bitbucket Cloud、 GitHub Enterprise Server GitHub、 GitLab.com、および GitLab セルフマネージドアクション用リソースに基づく Github アプリケーションベースの認証を使用します。Connections AWS CodeStar アプリケーションを GitHub 組織にインストールして、 でアクセスを管理できるようにします GitHub。

• 非推奨： GitHub バージョン 1 アクションでは、OAuth トークンを使用して で認証 GitHub し、別のウェブフックを使用して変更を検出します。これはもはや推奨される方法ではありません。

注記

接続は、アジアパシフィック (香港）、アジアパシフィック (ハイデラバード）、アジアパシフィック (ジャカルタ）、アジアパシフィック (メルボルン）、アジアパシフィック (大阪）、アフリカ (ケープタウン）、中東 (バーレーン）、中東 (アラブ首長国連邦）、欧州 (スペイン）、欧州 (チューリッヒ）、イスラエル (テルアビブ）、または AWS GovCloud （米国西部) の各リージョンでは利用できません。利用可能なその他のアクションについては、「との製品とサービスの統合 CodePipeline」を参照してください。欧州 (ミラノ) リージョンでのこのアクションに関する考慮事項については、「CodeStarSourceConnection Bitbucket Cloud、 GitHub Enterprise Server GitHub、 GitLab.com、および GitLab セルフマネージドアクション用」の注意を参照してください。

GitHub バージョン 1 アクションの代わりに GitHub バージョン 2 アクションを使用することには、いくつかの重要な利点があります。

• 接続を使用すると、リポジトリにアクセスするために OAuth アプリケーションや個人用アクセストークンが不要 CodePipeline になります。接続を作成するときは、 GitHub リポジトリへの認証を管理し、組織レベルでアクセス許可を付与する GitHub アプリをインストールします。リポジトリにアクセスするには、OAuth トークンをユーザーとして承認する必要があります。アプリベースの GitHub アクセスとは対照的に OAuth ベースの GitHub アクセスの詳細については、「」を参照してくださいhttps://docs.github.com/en/developers/apps/differences-between-github-apps-and-oauth-apps。

• CLI または で GitHub バージョン 2 のアクションを管理する場合 CloudFormation、個人用アクセストークンをシークレットとして Secrets Manager に保存する必要がなくなりました。 CodePipeline アクション設定で保存されたシークレットを動的に参照する必要がなくなりました。代わりに、アクション ARN に接続 ARN を追加します。アクション設定の例については、「CodeStarSourceConnection Bitbucket Cloud、 GitHub Enterprise Server GitHub、 GitLab.com、および GitLab セルフマネージドアクション用」を参照してください。

• で GitHub バージョン 2 アクションで使用する接続リソースを作成する場合 CodePipeline、同じ接続リソースを使用して、 CodeGuru Reviewer などのサポートされている他のサービスをリポジトリに関連付けることができます。

• Github バージョン 2 では、後続の CodeBuild アクションで git メタデータにアクセスするためのリポジトリのクローンを作成できますが、Github バージョン 1 ではソースのみダウンロードできます。

• 管理者が Organization のリポジトリにアプリをインストールします。トークンを作成した個人に依存する OAuth トークンを追跡する必要がなくなりました。

Organization にインストールされているすべてのアプリは、同じリポジトリのセットにアクセスできます。各リポジトリにアクセスできるユーザーを変更するには、各接続の IAM ポリシーを変更します。例については、「例: 指定したリポジトリとの接続を使用するためのスコープダウンポリシー」を参照してください。

このトピックのステップを使用して、 GitHub バージョン 1 のソースアクションを削除し、 CodePipeline コンソールから GitHub バージョン 2 のソースアクションを追加できます。

ステップ 1: バージョン 1 GitHub アクションを置き換える

パイプラインの編集ページを使用して、バージョン 1 GitHub アクションをバージョン 2 GitHub アクションに置き換えます。

バージョン 1 GitHub アクションを置き換えるには

1. CodePipeline コンソールにサインインします。

2. パイプラインを選択し、[編集] を選択します。ソースステージで、[ステージを編集] を選択します。アクションを更新することを推奨するメッセージが表示されます。

3. アクションプロバイダー で、 GitHub （バージョン 2) を選択します。

4. 次のいずれかを行います。

   • 「接続」で、プロバイダーへの接続をまだ作成していない場合は、「 に接続する GitHub」を選択します。ステップ 2: への接続を作成するに進みます GitHub。

   • [接続] でプロバイダへの接続を既に作成している場合は、その接続を選択します。ステップ 3： 接続のソースアクションを保存するに進みます。

ステップ 2: への接続を作成する GitHub

接続の作成を選択すると、Connect to GitHubページが表示されます。

への接続を作成するには GitHub

1. GitHub 接続設定 で、接続名 が接続名 に表示されます。

   GitHub アプリ で、アプリのインストールを選択するか、新しいアプリのインストールを選択して作成します。

   注記

   特定のプロバイダーへのすべての接続に対してアプリを 1 つインストールします。 GitHub アプリを既にインストールしている場合は、アプリを選択してこのステップをスキップします。

2. の認証ページ GitHub が表示されたら、認証情報を使用してログインし、続行することを選択します。

3. アプリのインストールページで、 AWS CodeStar アプリが GitHub アカウントに接続しようとしていることを示すメッセージが表示されます。

   注記

   アプリは GitHub アカウントごとに 1 回だけインストールします。アプリケーションをインストール済みである場合は、[Configure] (設定) を選択してアプリのインストールの変更ページに進むか、戻るボタンでコンソールに戻ることができます。

4. [ AWS CodeStarのインストール] ページで、[インストール] を選択します。

5. Connect to GitHub ページに、新しいインストールの接続 ID が表示されます。[接続]を選択します。

ステップ 3: GitHub ソースアクションを保存する

[アクションを編集] というページで更新を実行し、新しいソースアクションを保存します。

GitHub ソースアクションを保存するには

1. [リポジトリ] で、サードパーティーのリポジトリの名前を入力します。[ブランチ] で、パイプラインでソースの変更を検出するブランチを入力します。

   注記

   [Repository] で、例に示すように owner-name/repository-name を入力します。

   my-account/my-repository

2. [Output artifact format (出力アーティファクトのフォーマット)] で、アーティファクトのフォーマットを選択します。

   • デフォルトの メソッドを使用して GitHub アクションの出力アーティファクトを保存するには、CodePipeline デフォルトの を選択します。アクションは GitHub リポジトリからファイルにアクセスし、アーティファクトをパイプラインアーティファクトストアの ZIP ファイルに保存します。

   • リポジトリへの URL 参照を含む JSON ファイルを保存して、ダウンストリームのアクションで Git コマンドを直接実行できるようにするには、[Full clone (フルクローン)] を選択します。このオプションは、 CodeBuild ダウンストリームアクションでのみ使用できます。

     このオプションを選択した場合は、「」に示すように、 CodeBuild プロジェクトサービスロールのアクセス許可を更新する必要がありますBitbucket、、 GitHub Enterprise Server GitHub、または GitLab.com への接続の CodeBuild GitClone アクセス許可を追加する。フルクローン オプションの使い方を紹介したチュートリアルは、チュートリアル: GitHub パイプラインソースでフルクローンを使用する をご覧ください。

3. 出力アーティファクト　の場合、SourceArtifact のようにこのアクションの出力アーティファクトの名前を保持できます。[Done] を選択して、[アクションを編集] ページを閉じます。

4. [Done] を選択して、ステージの編集ページを閉じます。[Save] を選択して、パイプラインの編集ページを閉じます。