メインコンテンツまでスキップ

GitHubアプリの構成API

Bitrise GitHub アプリをインストールすると、デフォルトのGit接続方法として使用できます。Bitrise GitHub アプリ統合をAPI経由で設定します:

  • connection typeをOAuthからGitHubアプリに変更します。
  • GitHubアプリに定義された完全な権限をEnable theします。
  • 追加のリンクされたリポジトリを設定します。
  • GitHubアプリには不要なため、service credential userやその他のauthorization methodを削除します。

connection typeをOAuthからGitHubアプリに変更するClick to copy link​

重要な考慮事項

API経由でのOAuthへの切り替えは完全にはサポートされていません。プロジェクトをOAuthに戻すには、Bitrise UIによる手動対応が必要です。一括移行を実行する前に、一部のプロジェクトで移行プロセスをテストすることをお勧めします。

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

  • github
  • github-app

connection typeを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アプリの権限をビルドに拡張するClick to copy link​

Bitrise GitHubアプリは、アプリ経由でトリガーされた各ビルドに対して短期間の一時的なトークンを生成します。このトークンにはデフォルトで1つの権限(contents:read)のみが付与されます。つまり、ビルドはGitHubリポジトリにアクセスできますが、それ以外の操作は実行できません。

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

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

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アプリの権限をビルドに拡張するを参照してください。

追加のリンクされたリポジトリを設定するClick to copy link​

リンクされたリポジトリとは、BitriseプロジェクトがGitHubアプリのインストールを使用してアクセスできるものの、プロジェクトのプライマリリポジトリではないリポジトリのことです。追加のリポジトリがBitrise 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接続を削除するClick to copy link​

GitHubアプリの接続が機能している場合は、OAuth接続の構成要素を削除できます。これには以下が含まれます:

service credential userを削除するClick to copy link​

service credential userを削除するには:

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

SSHまたはHTTPの認証を削除するClick to copy link​

以前のauthorization methodを削除するには:

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