Skip to main content

GitHub アプリケーションコンフィギュレーション

概要

Configure the Bitrise Github app integration via the API: change the connection type from OAuth to the GitHub app, enable full permissions for the GitHub app, set additional linked repositories, and remove other authorization methods.

を設定します ビットライズ GitHub アプリインテグレーション API 経由で:

  • 接続タイプを OAuth から GitHub アプリケーションに変更します。

  • GitHub アプリに定義されているフル権限セットを有効にします。

  • 追加設定 リンクされたリポジトリー。

  • サービスクレデンシャルユーザとその他の認証方法は GitHub App には必要ないので削除してください。

接続タイプを OAuth から GitHub アプリケーションに変更する

重要な考慮事項

API による OAuth への復帰は完全にはサポートされていません。プロジェクトをOAuthに戻すには、Bitrise UIによる手動操作が必要です。お客様は、一括移行を実行する前に、一部のプロジェクトで移行プロセスをテストする必要があります

GitHub接続をOAuthアプリケーションからBitrise Githubアプリに変更するには、以下のAPIを使用してください。 POST /apps/{app-slug}/change-connection-type エンドポイント。指定できる値は次のとおりです。

  • github

  • github-app

GitHub アプリへの接続タイプを変更するには:

curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/change-connection-type' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "connection_type": "github-app"
}'

接続の変更は非破壊的な操作です。他の認証方法は削除されません。ビルドがまだ動作しているかどうかを確認できます。問題が発生した場合は、OAuth 接続に戻すことができます

接続を元に戻すには:

curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/change-connection-type' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "connection_type": "github"
}'

GitHub アプリの権限をビルドに拡張する

Bitrise GitHub Appは、アプリを介してトリガーされるビルドごとに短期の一時的なトークンを生成します。このトークンには、デフォルトで content: read という権限が 1 つしかありません。つまり、ビルドは GitHub リポジトリにアクセスできますが、

これらの権限を拡張して、ビルド中に他の操作を実行できるようにすることができます。たとえば、ユーザーはビルドから Git タグをプッシュしたり、カスタムステータスレポートを作成したり、プルリクエストにラベルを付けたり、新しいバージョン番号をプッシュしたりすることができます。

を使う use_full_permission のパラメーター PUT /apps/APP-SLUG/github-app-connection-configuration 権限を拡張するエンドポイント:

curl -X 'PUT' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/github-app-connection-configuration' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "use_full_permission_set": true
}'

さらに詳しい情報

権限の拡張とその方法の詳細については、GUI をご覧ください。 GitHub Appの権限をビルドに拡張する.

追加のリンクリポジトリを設定する

リンクされたリポジトリは、BitriseプロジェクトがGitHubアプリをインストールしてアクセスできるリポジトリですが、プロジェクトの主要リポジトリではありません。追加のリポジトリがインストールされている Bitrise GitHub App にリンクされている場合、ビルド用に生成されたトークンは追加のリポジトリにアクセスできます

その他のリンクリポジトリの詳細はこちら: GitHub アプリ経由でリンクされた追加のリポジトリ.

を使う POST /apps/APP-SLUG/github-app-connection-configuration/update-linked-repositories 追加のリポジトリをリンクします。次の 2 つの選択肢があります。

  • リポジトリのフルネームを手動で一覧表示します。

    curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/github-app-connection-configuration/update-linked-repositories' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "repositories": ["org1/repo1", "org1/repo2"]
}'

  • を設定 unlimited_repo_access フィールドを true に設定すると、ビルドが現在および将来のすべてのリポジトリにアクセスできるようになります。

    curl -X 'POST' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/github-app-connection-configuration/update-linked-repositories' \
  -H 'accept: application/json' \
  -H 'Authorization: ACCESS-TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "unlimited_repo_access": true
}'

OAuth コネクションを削除する

GitHub App 接続がうまくいけば、OAuth 接続のコンポーネントを削除できます。

サービスクレデンシャルユーザーの削除

サービスクレデンシャルユーザーを削除するには:

curl -X 'DELETE' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/service-credential-user' \
  -H 'Authorization: ACCESS-TOKEN'

SSH 認証または HTTP 認証の削除

以前の認証方法を削除するには:

curl -X 'DELETE' \
  'https://api.bitrise.io/v0.1/apps/APP-SLUG/repository-authorization ' \
  -H 'Authorization: ACCESS-TOKEN'
このセクションの内容: