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

iOS code signingファイルの管理: 自動プロビジョニング

Bitriseでは、iOSのcode signingをできるだけシンプルにすることを目指しています。そのため、プロセスの多くを自動化するよう努めています。Stepsの一部には、automatic code signing管理のビルトインオプションが搭載されており、設定がより効率化されています。

この文脈におけるAutomatic code signingとは、Apple Developer Portalアカウントで利用可能なプロビジョニングプロファイルを自動的に管理することを意味します。Appleアカウントへの何らかの認証を設定すると、ビルドプロセス中にBitriseがアプリ用のプロビジョニングプロファイルをダウンロードしてインストールできます。

この機能を使用するには、次の操作が必要です。

  1. コードsigning certificateをBitriseにアップロードします。
  2. Apple IDまたはApp Store Connect APIのいずれかを使用して、Apple Developer PortalアカウントをBitriseに接続します。
  3. code signingアセットの自動管理をサポートするStepsのいずれかを使用します。

iOSコードsigning certificateをBitriseにアップロードするClick to copy link​

iOSのcode signing方法はすべて、iOSコードsigning certificateをエクスポートしてBitriseにアップロードする必要があります。

code signingファイルの生成

必要なcode signingファイルが用意されていない場合は、新しいファイルを生成できます。iOSのcode signingファイルを生成する

証明書をBitriseにアップロードするには、まずファイルを.p12ファイル形式でエクスポートする必要があります。ファイルのエクスポートに成功したら、それらをBitriseにアップロードします。次の2つのオプションがあります。

  • API呼び出し経由
  • 手動でアップロードする。このガイドではこちらの方法について説明します。
配布用と開発用の両方のsigning certificateをアップロードする

プロジェクトの開発用と配布用の両方のsigning certificateをアップロードすることを強くおすすめします。開発用のsigning certificateがアップロードされていない場合、自動プロビジョニングオプションを備えたStepsは、ビルドを開始するたびにその場で新しいものを生成します。これにより、最終的に証明書の最大数に達し、新しいビルドを開始できなくなる可能性があります。

証明書をエクスポートし、Workflow EditorでBitriseにアップロードするには、次の操作を行います。

  1. .p12証明書がエクスポートされ、準備できていることを確認します。

  2. プロジェクトに対するAdminのロールを持つユーザー、またはEdit workflow権限を持つカスタムロールを持つユーザーで、Bitrise上のプロジェクトを開きます。

  3. プロジェクトのメインページで、Project settingsボタンをクリックします。

  4. 左側で、Code signingメニューオプションを選択します。

  5. 証明書を追加するには、Add .p12 fileをクリックします。

  6. ダイアログボックスで、証明書ファイルをフィールドにドラッグ&ドロップするか、フィールドをクリックしてファイルを参照します。

    Add .p12 fileダイアログ

    Certificate password

    証明書がパスワードで保護されている場合は、ここでもパスワードを設定する必要があります。

  7. 完了したら、Continueをクリックします。

  8. サマリーを確認し、問題がなければAdd certificateをクリックします。

自動プロビジョニングのためのAppleサービス認証Click to copy link​

ビルトインの自動化されたiOS code signingオプションを提供するBitrise Stepsを活用するには、Appleサービス認証を設定する必要があります。これらのStepsには、2つのオプションがあります。

認証方法仕組み使用するタイミング
APIキー認証(推奨)APIキーを使用して、App Store ConnectアカウントをBitriseに接続します。Apple Developer Enterprise Programのアカウントを使用している場合を除き、このオプションの使用をおすすめします。APIキーを作成するオプションが表示されず、アクセスのリクエストがグレーアウトしている場合は、アカウント保有者に連絡してAPI認証を使用するためのAppleとのライセンス契約に同意してもらう必要があります。
Apple ID認証Apple IDをBitriseに接続します。Appleアカウントで二要素認証が有効になっている場合は、この過程でApp-specific passwordを入力する必要があります。認証の有効期限は30日で、接続を更新する必要があります。次の場合にのみ、この方法を使用してください。 - 何らかの理由でAPIキーにアクセスできない。 - Apple Developer Enterprise Programのアカウントを使用している。 手動プロビジョニングの使用も検討できます。

自動プロビジョニング用のStepsの設定Click to copy link​

Bitriseで自動プロビジョニングを処理する方法は2つあります。

  • code signingファイルの管理とアプリのビルドの両方を行える、公式のXcode Stepsを使用する。
  • Manage iOS Code SigningStepを使用する。

次の表は、2つの方法のユースケースを説明しています。必要なStepsを設定するには、以下のいずれかを確認してください。

Certificate and profile installer Stepを使用しないでください

自動プロビジョニングを使用する場合、Certificate and profile installerStepを使用する必要は一切ありません。

Steps仕組み使用するタイミング
Xcode Steps: - Xcode Archive & Export for iOS - Export iOS and tvOS Xcode Archive - Xcode build for testing for iOSこれらのStepsは、ほぼ設定不要でXcodeプロジェクトにcode signingを自動的に設定します。ほとんどのシナリオでは、これらのStepsを使用することをおすすめします。
Manage iOS Code SigningStepこのStepは、ビルドの実行前にXcodeプロジェクトにcode signingを設定します。次の場合、この専用のStepを使用できます。 - スクリプトまたはfastlaneからアプリをビルドしている。 - クロスプラットフォームプロジェクトを使用している(例:React Native、Flutter、Ionic、Cordovaなど)。 - macOSアプリをビルドしている。

Xcode Stepsを使用するClick to copy link​

code signingアセットのビルトイン自動管理機能を備えたXcode Stepsのいずれかを使用できます。

  1. AppleサービスへのSet up接続。

    APIキー認証またはApple ID認証のいずれかを選択できます。一般的にはAPIキー認証をおすすめします。

  2. 必要に応じて、次のStepsのいずれかをWorkflowに追加します。

    • Xcode Archive & Export for iOS: Xcodeアプリをビルドし、選択したタイプのIPAをエクスポートします。
    • Export iOS and tvOS Xcode Archive: 既存のアーカイブからIPAをエクスポートします。
    • Xcode build for testing for iOS: build-for-testingアクションを使用してXcodeアプリをビルドします。
  3. Automatic code signing methodの入力を、設定したAppleサービス認証タイプに設定します。

    たとえば、APIキー認証を選択した場合は、api-keyオプションを選択します。

code signing方式を設定するYAMLの例

この例では、Xcode Archive & Export for iOSStepがAPIキー認証を使用するように設定されています。

- xcode-archive@4:
inputs:
- automatic_code_signing: api-key

ほとんどの場合、Apple接続を正しく設定していれば、他のすべての入力についてはdefault valueで十分です。

Manage iOS Code Signing Stepを使用するClick to copy link​

iOSアプリのビルドにXcode Stepsのいずれも使用しない場合、またはクロスプラットフォームアプリを使用している場合は、code signingアセットを自動的に管理するための専用のStepを使用してください。

  1. Run CocoaPods installやCarthageなど、Workflow内の依存関係インストーラーStepの後にManage iOS Code SigningStepを追加します。

    manage-ios-code.png

  2. Apple service connection methodの入力を、使用したいApple service connectionに設定します。

    APIキー認証またはApple ID認証のいずれかを選択できます。

  3. Apple ID認証を使用する場合は、The Developer Portal team IDの入力にチームIDも入力する必要があります。

  4. このStepの後にXcodeプロジェクトを変更しないようにしてください。

    たとえば、バンドルIDを変更しないでください。

  5. fastlaneStepなど、アプリをビルドしてアーカイブするStepを追加します。

エクスポートオプションのplistを生成するClick to copy link​

ExportOptions.plistファイルは、iOS向けのXcode ArchiveStep inputsに基づいて自動的に生成されます。ただし、これらの入力を上書きして、Xcode Archive & Export for iOSStepで使用することもできます。

  1. ローカルの開発マシンXcodeでプロジェクトを開きます。
  2. プロジェクトをアーカイブします。
  3. Organizerで、新しく作成された.xcarchiveファイルを選択します。Distribute AppをクリックしてIPAファイルにエクスポートします。Xcodeは、使用されたExportOptions.plistファイルを、生成されたIPAファイルの隣にコピーします。
  4. お好みのテキストエディタでこのExportOptions.plistファイルを開き、その内容をコピーします。
  5. その内容を、Xcode Archive & Export for iOSStepのExport options plistコンテンツ入力に貼り付けます。
plistファイルの例:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>destination</key>
<string>export</string>
<key>method</key>
<string>debugging</string>
<key>signingStyle</key>
<string>automatic</string>
<key>stripSwiftSymbols</key>
<true/>
</dict>
</plist>