ツールチェーンにおけるソースリポジトリとしての GitHub の設定

Continuous Delivery 2027年2月12日をもって、以下の地域での提供が終了となります: au-syd、 ca-tor、 us-east。 また、同日をもって、Code Risk Analyzerもすべての地域で提供を終了いたします。 あるリージョンでこれらの機能が実際に利用されていない場合、そのリージョンの機能は早期に提供が終了し、新しいインスタンスの受け入れが停止される可能性があります。 詳細はこちら

IBM Cloud ツールチェーンで GitHub を設定し、ソースコードの管理、プルリクエストを通じた共同作業、およびコードの変更に伴うパイプラインの実行をトリガーできるようにします。

GitHub Enterprise は、オンプレミス型の Web ベースの Git リポジトリー・ホスティング・サービスです。

GitHub Issues は、作業と計画のすべてを 1 つの場所に保持するトラッキング・ツールです。 これは、ユーザーが重要タスクに注力できるようにユーザーの開発リポジトリーと統合されます。

GitHub.com または会社の GitHub Enterprise インスタンスの新規または既存のリポジトリーでソース・コードを管理できるように、ツールチェーン内の 1 つのツール統合として GitHub を構成できます。 Wiki、問題のトラッキング、プル・リクエストを介してソーシャル・コーディングに参加します。

ツールチェーンの作成時にこのツール統合を構成する場合は、次の手順を実行します。

  1. GitHub リポジトリーにソース・コードを格納している場合は、「構成可能な統合」セクションで**「GitHub」**をクリックします。 IBM Cloud Public でこのツールの連携を設定する場合は、 IBM Cloud が GitHub にアクセスできるよう、 OAuth、「 個人用アクセストークン」、または「 GitHub アプリ 」を選択して、 が にアクセスできるよう承認する必要があります。

    • OAuth を選択した場合は、 Authorize をクリックして GitHub ウェブサイトにアクセスしてください。 アクティブな GitHub セッションがない場合は、ログインするよう求められます。 「アプリケーションを許可 (Authorize Application)」 をクリックして、IBM Cloud が GitHub アカウントにアクセスできるようにします。 アクティブな GitHub セッションはあるものの、最近パスワードを入力していない場合は、確認のために GitHub パスワードの入力を求められることがあります。

    • 「個人アクセス・トークン (Personal Access Token)」を選択した場合は、リポジトリーを複製して他のアクションを実行するために GitHub での許可に使用する個人アクセス・トークンを入力する必要があります。 個人用アクセス・トークンがない場合は、 GitHub Web サイトにある資料に従って作成できます。 個人用アクセス・トークンに repo、 delete_repo、 read:user、および workflow の各権限があることを確認します。

    • 「 GitHub 」アプリを選択した場合、 IBM Cloud は、「 OAuth 」トークンの代わりに、「 GitHub 」アプリのインストール情報を使用して、ユーザーに代わって GitHub への認証を行います。 GitHub アプリでは、よりきめ細かな権限制御が可能であり、個々のユーザーの認証情報に依存しません。 以下のいずれかの方法を選択してください。

      • マネージド — GitHub サーバー用に事前設定済みの、 IBM が提供する GitHub アプリを使用します。 「承認 」をクリックすると、 GitHub, にリダイレクトされ、そこでアプリによるアカウントへのアクセスを承認します。

      • カスタム — ご自身の GitHub アプリをお持ち込みください。 登録およびインストール済みのxml-ph-0001@deepl.internalアプリの App ID、およびリポジトリに登録・インストール済みの GitHub アプリの秘密鍵 ( PEM 形式)を入力してください。 この連携機能で利用したいリポジトリには、必ずこのアプリをインストールしておく必要があります。 GitHub アプリの作成に関する詳細については、『 GitHub 』のドキュメントを参照してください。

  2. ご自身の GitHub Enterprise サーバー上のリポジトリを使用している場合は、設定可能な統合セクションでカスタムサーバー をクリックしてください。

    a. カスタム GitHub サーバーのタイトルを入力し、サーバー URL のルートを指定し、個人用アクセストークンを入力してください。

    b. 個人用アクセス・トークンがない場合は、 GitHub Web サイトにある資料に従って作成できます。

    c. GitHub サーバーがエアギャップされていたり、公共のインターネットからアクセスできない場合は、Delivery Pipeline Private Worker を接続して統合し、独自の Kubernetes インフラストラクチャ上で実行することで、内部またはオンプレミスのリソースにアクセスすることができます。 Delivery Pipelineプライベート・ワーカーについての詳細は、Delivery Pipelineプライベート・ワーカーでの作業 を参照してください。

    d. GitHub Enterprise サーバーに GitHub アプリが登録されている場合は、「 GitHub 」アプリ認証方法を選択して、 App ID と秘密鍵を入力するか、サーバー用に事前に設定済みのマネージドアプリを使用することもできます。

  3. GitHub リポジトリーのデフォルトのターゲット・リポジトリーの場所を確認します。 これらのリポジトリーは、サンプル・リポジトリーのクローンです。 必要に応じて、ターゲット・リポジトリーの名前を変更します。

既存のツールチェーンにツール統合を追加する場合は、以下の手順に従います。

  1. コンソール IBM Cloud から、 メニュー アイコン( ハンバーガーアイコン ) > プラットフォーム自動化 > ツールチェーンをクリックします。 「ツールチェーン」ページで、ツールチェーンをクリックしてその「概要」ページを開きます。

  2. **「ツールの追加」**をクリックします。

  3. 「ツール統合」セクションで、**「GitHub」**をクリックします。

  4. 使用する GitHub サーバーをクリックします。

  5. 既存の GitHub または GitHub Enterprise リポジトリーを使用する場合は、リポジトリーのタイプとして**「既存」**をクリックし、URL を入力します。

  6. 新しい GitHub または GitHub Enterprise リポジトリーを使用する場合は、そのリポジトリーに付ける名前を入力し、複製またはフォークするリポジトリーの URL を入力し、リポジトリー・タイプを次のように選択します。

    a. 空のリポジトリーを作成する場合は、**「新規」**をクリックします。

    b. GitHub または GitHub Enterprise リポジトリーのコピーを作成する場合は、**「クローンを作成する (Clone)」**をクリックします。

    c. GitHub または GitHub Enterprise リポジトリーをフォークし、プル・リクエストで変更内容を提供できるようにする場合は、**「フォーク (Fork)」**をクリックします。

  7. アップグレードしたアカウントを持つ GitHub.com ユーザーの場合、または GitHub Enterprise サーバーを選択してこのサーバー上に新規のプライベート・リポジトリーを作成する場合は、**「このリポジトリーをプライベートにする (Make this repository private)」**チェック・ボックスを選択します。

  8. 問題のトラッキングに GitHub Issues を使用する場合は、**「GitHub Issues を使用可能にする (Enable GitHub Issues)」**チェック・ボックスにチェック・マークを付けます。

  9. コミットに対するタグおよびコメントと、コミットで参照される問題に対するラベルおよびコメントを作成することによって、コード変更のデプロイメントをトラッキングしたい場合は、**「コード変更のデプロイメントを追跡する (Track deployment of code changes)」**チェック・ボックスにチェック・マークを付けます。

  10. 「統合の作成」 をクリックします。

  11. ツールチェーンの「概要」ページの**「リポジトリー」**カードで、処理する GitHub または GitHub Enterprise リポジトリーをクリックします。 選択したリポジトリーに応じて、GitHub Web サイトか会社の GitHub Enterprise リポジトリーが開きます。ここで、リポジトリーのコンテンツを表示できます。

  12. GitHub Issues を使用可能にした場合、**「GitHub Issues」**をクリックして開きます。 ツールチェーンに複数の GitHub または GitHub Enterprise リポジトリーが含まれれている場合でも、GitHub Issues のこのインスタンスをツールチェーン全体に使用できます。

    リンクしようとしているリポジトリーに対する管理特権をお持ちでない場合、Web フックを使用できないので統合は制限されます。 リポジトリーにコミットがプッシュされたときにパイプラインが自動的に実行されるようにするには、Web フックが必要です。 Web フックがない場合、パイプラインを手動で開始する必要があります。

API を使用した GitHub の設定

ツール GitHub 統合は 、ツールチェーン HTTP API および SDK を使用してツール統合 を作成、 読み取り、 更新する際に使用できる以下の構成パラメーターをサポートしています。

githubconsolidated 値を使用して、要求本体に tool_type_id プロパティーを指定する必要があります。

GitHubツール統合パラメータ
パラメーター 使用法 タイプ Terraform 引数 説明
API のルート URL オプション、更新可能 ストリング API のルート URL API ル URL ートの サーバーの GitHub。
API トークン オプション、更新可能 パスワード API トークン パーソナル・アクセス・トークン(PAT)。 このパラメーターは、 auth_type が pat に設定されている場合にのみ必要です。それ以外の場合は無視されます。
auth_type オプション、更新可能 ストリング auth_type Git プロバイダーにアクセスする際に使用する認証方法を設定します。 有効な値は、 oauth、 pat、および github_app です。 github_app が指定された場合、認証には、ユーザーの OAuth トークンやPATの代わりに、 GitHub アプリのインストールトークンが使用されます。
自動初期化 オプション、不変、 Default: false ブール値 自動初期化 このリポジトリーを README ファイルで初期化するには、この値を true に設定します。 このパラメーターは、リポジトリーを作成する場合にのみ使用します。
インデント接続 任意、更新可能、 Default: false ブール値 インデント接続 この値を true に設定することは、サーバーがパブリック・インターネット上でアドレス可能でないことを意味します。 IBM Cloud は、指定された接続の詳細を検証できません。 Git サーバーへの API アクセスを必要とする特定の機能は無効になります。 デリバリー・パイプラインは、Git サーバーへのネットワーク・アクセス権限を持つプライベート・ワーカーのみを使用して機能します。
デフォルト・ブランチ オプション、更新可能 ストリング デフォルト・ブランチ Git リポジトリーのデフォルトのブランチです。
enable_traceability 任意、更新可能、 Default: false ブール値 enable_traceability この値を に設定すると、コミット、プルリクエスト、および参照されている課題に対してタグ、ラベル、コメントを作成することで、コード変更のデプロイ状況を追跡 true できます。
Git_id オプション、不変 ストリング Git_id この値を github ( github.comの場合)、またはカスタム GitHub Enterprise サーバーの GUID に設定します。
github_app_auth_method オプション、更新可能 ストリング github_app_auth_method auth_type が github_app の場合に使用する、 GitHub アプリの認証方法は以下の通りです。 「 managed 」に設定すると、 IBM が提供する GitHub アプリ(デフォルト)が使用されます。あるいは、「 custom 」に設定すると、 github_app_credential_app_id および github_app_credential_private_key を通じて、独自の GitHub アプリの認証情報を指定できます。
github_app_credential_app_id オプション、更新可能 ストリング github_app_credential_app_id GitHub App ID では、 GitHub 用のカスタムアプリを提供しています。 github_app_auth_method が custom の場合に必要です。
github_app_credential_private_key オプション、更新可能 パスワード github_app_credential_private_key カスタム GitHub アプリ用のRSA秘密鍵( PEM 形式)。 github_app_auth_method が custom の場合に必要です。 鍵は暗号化された状態で保存されます。
has_issues 任意、更新可能、 Default: true ブール値 ツールチェーンの発行が有効 GitHub リポジトリーで問題を有効にし、ツールチェーンに問題ツール・カードを追加するには、この値を true に設定します。 ツールチェーンからツール統合カードを削除するには、値を false に設定します。 この設定は、 GitHub リポジトリー自体で問題が有効になっているかどうかには影響しません。
統合所有者 オプション、更新可能 ストリング 統合所有者 Git 操作の実行に使用するユーザーを選択します。
owner_id オプション、不変 ストリング owner_id リポジトリーを所有している GitHub ユーザーまたは組織。 このパラメーターは、リポジトリーを作成する場合、またはリポジトリーを複製またはフォークする場合に必要です。 この値は、既存のリポジトリーにリンクすると計算されます。
プライベート・リポジトリー オプション、不変、 Default: false ブール値 プライベート・リポジトリー この値を true に設定すると、リポジトリーの作成時、クローン作成時、またはフォーク時にリポジトリーがプライベートになります。 既存のリポジトリーにリンクする場合、このパラメーターは使用されません。
リポジトリー ID オプション、不変 ストリング リポジトリー ID GitHub リポジトリーの ID。
repo_name オプション、不変 ストリング repo_name 作成する GitHub リポジトリーの名前。 このパラメーターは、リポジトリーを作成する場合、またはリポジトリーを複製またはフォークする場合に必要です。 この値は、既存のリポジトリーにリンクすると計算されます。
repo_url オプション、不変 ストリング repo_url このツール統合 GitHub のリポジトリ URL の 既存のリポジトリーにリンクする場合、このパラメーターは必須です。 この値は、リポジトリーを作成するとき、またはリポジトリーを複製またはフォークするときに計算されます。
ルート URL オプション、更新可能 ストリング ルート URL サーバーの URL ルート。例: https://github.example.com
ソース repo_URL オプション、不変 ストリング ソース repo_URL あなたがフォークまたはクローンしているリポジトリの URL このパラメーターは、リポジトリーをフォークまたはクローン作成する場合に必要です。 これは、リポジトリーを作成するとき、または既存のリポジトリーにリンクするときには使用されません。
title オプション、更新可能 ストリング title サーバーのタイトルです。 例: My GitHub Enterprise Server
トークン URL オプション、更新可能 ストリング トークン URL サーバー GitHub への認証に使用されるトークン URL。
タイプ 必須、変更不可能 ストリング タイプ 新規ツール統合を初期化するために実行する操作。 new を使用して Git リポジトリーを作成します。 clone を使用して既存のリポジトリーを新しい Git リポジトリーに複製します。 fork を使用して既存の Git リポジトリーをフォークするか、 link を使用して既存の Git リポジトリーにリンクします。

GitHub App 認証の使用方法

GitHub アプリ認証は、 OAuth やPersonal Access Token(PAT)といった方法に代わる手段です。 GitHub アプリはユーザーとしてではなくアプリケーションとして認証を行うため、リポジトリに対するよりきめ細かな権限設定が可能となり、個々のアカウント認証情報に依存せず、特定のリポジトリに限定された範囲で自動的に更新されるトークンが発行されます。

2つのモードが利用可能です:

管理対象 (github_app_auth_method: managed )
IBM Cloud IBM が提供する アプリを使用しており、このアプリは サーバーに対してあらかじめ登録されています。 GitHub GitHub OAuth の同意フローを通じてアプリへのアクセス許可を行い、その結果生成されるユーザーからサーバーへのトークン(ghu_ )が自動的に保存・使用されます。
カスタム (github_app_auth_method: custom)
GitHub または GitHub Enterprise で、ご自身の「 GitHub 」アプリを登録・管理してください。 App ID および PEM 形式でエンコードされた RSA 秘密鍵を指定してください。 IBM Cloud は、これらの認証情報を使用して、有効期間が短いインストール用アクセストークン (ghs_) を自動的に生成します。 この連携機能で利用したいすべてのリポジトリに、「 GitHub 」アプリをインストールする必要があります。

GitHub アプリのカスタム認証を開始する前に

GitHub アプリのカスタム認証を設定する前に、以下の手順を完了してください

  1. GitHub の組織または個人アカウントで、 GitHub アプリを作成します。 アプリに対して、少なくとも以下のリポジトリ権限を付与してください:

    • 内容 :読み取りと書き込み
    • メタデータ :読み取り専用
    • プルリクエスト :読み取りおよび書き込み(プルリクエストの追跡機能を利用している場合)
    • ワークフロー :読み取りおよび書き込み(パイプラインが GitHub アクションをトリガーする場合)
  2. アプリの秘密鍵を生成し、 PEM ファイルを保存してください。 このキーは、連携の設定を行う際に必要になります。

  3. ツールチェーンがアクセスする組織またはリポジトリに、 GitHub アプリをインストールしてください。 認証情報を検証するには、まずアプリをインストールする必要があります。

App ID および秘密鍵を使用してツールの連携設定を完了すると、 IBM Cloud は GitHub APIを呼び出して、認証情報を検証します。 指定されたリポジトリにアプリがまだインストールされていない場合、まずアプリをインストールするよう促すエラーメッセージが表示されます。