への接続 GitHubを作成する (コンソール）（ GitHub CLI) への接続を作成する

GitHub 接続

接続を使用すると、サードパーティープロバイダを AWS リソースと紐付ける構造の承認と設立ができます。

注記

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

で GitHub または GitHub Enterprise Cloud リポジトリのソースアクションを追加するには CodePipeline、次のいずれかを選択できます。

CodePipeline コンソールのパイプライン作成ウィザードまたはアクションの編集ページを使用して、 GitHub （バージョン 2) プロバイダーオプションを選択します。アクションを追加するには GitHub Enterprise Server への接続を作成する (コンソール）を参照してください。このコンソールは、接続リソースの作成に役立ちます。

注記
GitHub 接続を追加し、パイプラインでフルクローンオプションを使用する方法を説明するチュートリアルについては、「」を参照してくださいチュートリアル: CodeCommit パイプラインソースで完全なクローンを使用する。
CodeStarSourceConnection アクションのアクション設定を GitHub プロバイダに追加するには、パイプラインを作成する (CLI) に記載されている CLI 手順に従います。

注記

[設定] からデベロッパーツールコンソールを使用して、接続を作成することもできます。[接続を作成する] を参照してください。

開始する前に:

でアカウントを作成しておく必要があります GitHub。
GitHub コードリポジトリを作成しておく必要があります。
CodePipeline サービスロールが 2019 年 12 月 18 日より前に作成された場合は、AWS CodeStar接続codestar-connections:UseConnectionに使用するアクセス許可の更新が必要になる場合があります。手順については、「 CodePipeline サービスロールにアクセス許可を追加する」を参照してください。

注記

接続を作成するには、 GitHub 組織の所有者である必要があります。組織のリポジトリでない場合、ユーザーがリポジトリの所有者である必要があります。

への接続 GitHubを作成する (コンソール）

CodePipeline コンソールを使用して、または GitHub Enterprise Cloud リポジトリの接続アクション GitHubを追加するには、次の手順に従います。

注記

これらのステップでは、[リポジトリアクセス] で特定のリポジトリを選択できます。選択されていないリポジトリは、によってアクセスまたは表示されません CodePipeline。

ステップ１：パイプラインを作成または修正するには

CodePipeline コンソールにサインインします。
次のいずれかを選択します。
- パイプラインの作成を選択します。[パイプラインを作成する] の手順に従い最初の画面を完了し、[次] を選択します。ソースページのソースプロバイダー で、 GitHub （バージョン 2) を選択します。
- 既存のパイプラインを編集することを選択します。[Edit]、[Edit Stage] の順に選択します。ソースアクションを追加または編集するかを選択します。[アクションの編集] ページで、[Action name (アクション名)] に自分のアクション名を入力します。アクションプロバイダー で、 GitHub （バージョン 2) を選択します。
次のいずれかを行います。
- 接続で、プロバイダーへの接続をまだ作成していない場合は、接続 GitHubを選択します。ステップ 2: への接続を作成するに進みます GitHub。
- [接続] でプロバイダへの接続を既に作成している場合は、その接続を選択します。ステップ 3：接続のソースアクションを保存するに進みます。

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

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

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

GitHub 接続設定 の下に、接続名が接続名 に表示されます。に接続 GitHubを選択します。アクセス要求のページが表示されます。
のAWSコネクタを承認を選択します GitHub。接続ページが表示され、GitHub アプリフィールドが表示されます。
GitHub アプリ で、アプリのインストールを選択するか、新しいアプリをインストールして作成します。

注記
特定のプロバイダーへのすべての接続に対してアプリを 1 つインストールします。AWS Connector for GitHub app を既にインストールしている場合は、それを選択してこのステップをスキップします。
「のAWSコネクタをインストールする GitHub」ページで、アプリケーションをインストールするアカウントを選択します。

注記
アプリは GitHub 、アカウントごとに 1 回だけインストールします。アプリケーションをインストール済みである場合は、[Configure] (設定) を選択してアプリのインストールの変更ページに進むか、戻るボタンでコンソールに戻ることができます。
Install AWS Connector for GitHub ページで、デフォルトのままにして、Install を選択します。
「に接続 GitHubGitHub 」ページに、新しいインストールの接続 ID がアプリ に表示されます。[接続]を選択します。

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

[アクションを編集] ページで次の手順を使用し、ソースアクションを接続情報とともに保存します。

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

[リポジトリ名] で、サードパーティーのリポジトリの名前を選択します。
パイプライントリガーでは、アクションが CodeConnections アクションの場合にトリガーを追加できます。パイプライントリガー設定を設定し、オプションでトリガーでフィルタリングするには、「」で詳細を参照してくださいコードプッシュまたはプルリクエストでトリガーをフィルタリングする。
[Output artifact format (出力アーティファクトのフォーマット)] で、アーティファクトのフォーマットを選択する必要があります。
- デフォルトのメソッドを使用して GitHub アクションからの出力アーティファクトを保存するには、CodePipeline デフォルトの を選択します。アクションは GitHub リポジトリからファイルにアクセスし、パイプラインアーティファクトストアの ZIP ファイルにアーティファクトを保存します。
- リポジトリへの URL 参照を含む JSON ファイルを保存して、ダウンストリームのアクションで Git コマンドを直接実行できるようにするには、[Full clone (フルクローン)] を選択します。このオプションは、 CodeBuild ダウンストリームアクションでのみ使用できます。
  
  このオプションを選択した場合は、「」に示すように、 CodeBuild プロジェクトサービスロールのアクセス許可を更新する必要がありますBitbucket、 GitHub Enterprise Server GitHub、または GitLab.com への接続の CodeBuild GitClone アクセス許可を追加する。[完全クローン] オプションを使用する方法を示すチュートリアルについては、チュートリアル: CodeCommit パイプラインソースで完全なクローンを使用するを参照してください。
ウィザード上で [次へ] または [保存] を [アクションを編集] ページで選択します。

（ GitHub CLI) への接続を作成する

AWS Command Line Interface (AWS CLI) を使用して接続を作成できます。

これを行うには、create-connection コマンドを使用します。

重要

AWS CLI または AWS CloudFormation を使用して作成された接続は、デフォルトで PENDING ステータスになります。CLI または AWS CloudFormation を使用して接続を作成した後、コンソールを使用して接続を編集し、ステータスを AVAILABLE に変更します。

接続を作成する

ターミナル (Linux/macOS/Unix) またはコマンドプロンプト (Windows) を開きます。AWS CLI を使用して、create-connection コマンドを実行し、接続に --provider-type と --connection-name を指定します。この例では、サードパーティープロバイダー名は GitHub で、指定された接続名は MyConnection です。
```
aws codestar-connections create-connection --provider-type GitHub --connection-name MyConnection
```
成功した場合、このコマンドは次のような接続 ARN 情報を返します。
```
{
    "ConnectionArn": "arn:aws:codestar-connections:us-west-2:account_id:connection/aEXAMPLE-8aad-4d5d-8878-dfcab0bc441f"
}
```
コンソールを使用して接続を完了します。詳細については、「Update a pending connection」を参照してください。
パイプラインはデフォルトで、接続ソースリポジトリへのコードのプッシュ時に変更を検出するようになっています。パイプライントリガーを手動リリース用または Git タグ用に設定するには、以下のいずれかを行います。
- 手動リリースでのみ開始するようにパイプラインのトリガー設定を構成するには、設定に以下の行を追加します。
```
"DetectChanges": "false",
```
- トリガーでフィルタリングするようにパイプライントリガー設定を構成するには、「」で詳細を参照してくださいコードプッシュまたはプルリクエストでトリガーをフィルタリングする。例えば、以下ではパイプライン JSON 定義のパイプラインレベルにを追加します。この例では、release-v0 と release-v1 が包含する Git タグで、release-v2 が除外する Git タグです。
```
"triggers": [
            {
                "providerType": "CodeStarSourceConnection",
                "gitConfiguration": {
                    "sourceActionName": "Source",
                    "push": [
                        {
                            "tags": {
                                "includes": [
                                    "release-v0", "release-v1"
                                ],
                                "excludes": [
                                    "release-v2"
                                ]
                            }
                        }
                    ]
                }
            }
        ]
```

ブラウザで JavaScript が無効になっているか、使用できません。

AWS ドキュメントを使用するには、JavaScript を有効にする必要があります。手順については、使用するブラウザのヘルプページを参照してください。

ドキュメントの表記規則

CodeCommit ソース (AWS CloudFormation テンプレート) の EventBridge ルールを作成する

GitHub Enterprise Server 接続