GitHub (OAuth アプリ経由) ソースアクションを GitHub (GitHub アプリ経由) ソースアクションに更新する - AWS CodePipeline

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

GitHub (OAuth アプリ経由) ソースアクションを GitHub (GitHub アプリ経由) ソースアクションに更新する

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

注記

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

GitHub (OAuth アプリ経由) アクションの代わりに GitHub (GitHub アプリ経由) アクションを使用することには、いくつかの重要な利点があります。

  • 接続により、CodePipeline はリポジトリにアクセスするために OAuth アプリやパーソナルアクセストークンを必要としなくなりました。接続を作成するときは、GitHub リポジトリへの認証を管理し、Organization レベルで権限を許可する GitHub アプリをインストールします。リポジトリにアクセスするには、OAuth トークンをユーザーとして承認する必要があります。アプリベースの GitHub アクセスとは対照的な OAuth ベースの GitHub アクセスの詳細については、https://docs.github.com/en/developers/apps/differences-between-github-apps-and-oauth-apps を参照してください。

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

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

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

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

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

このトピックのステップを使用して、GitHub (OAuth アプリ経由) ソースアクションを削除し、CodePipeline コンソールから GitHub (GitHub アプリ経由) ソースアクションを追加できます。

ステップ 1: (OAuth アプリ経由で) GitHub アクションを置き換える

パイプライン編集ページを使用して、 (OAuth アプリ経由) GitHub アクションを GitHub (GitHub アプリ経由) アクションに置き換えます。

(OAuth アプリ経由) GitHub アクションを置き換えるには
  1. CodePipeline コンソールにサインインします。

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

  3. アクションプロバイダーで、GitHub (GitHub アプリ経由) を選択します。

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

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

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

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

接続の作成を選択した後、[Connect to GitHub] ページが表示されます。

GitHub への接続を作成するには
  1. [GitHub connection settings] で、[Connection name] に接続名が表示されます。

    [GitHub Apps] で、アプリケーションのインストールを選択するか、[Install a new app] (新しいアプリケーションをインストールする) を選択してアプリケーションを作成します。

    注記

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

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

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

    注記

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

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

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

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

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

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

    注記

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

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

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

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

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

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

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