新しいステップの開発

NS title プロパティは、ステップの名前を設定します。 bitrise.io。短くて説明的なものにする必要があります。サービスの名前と、サービスが実行する機能などを含めます。 Gitクローン。ステップタイトルのガイドラインは次のとおりです。

ステップに関する最も重要な情報の1行。 100文字を超えることはできません。

要約は、デフォルトでワークフローエディターに表示されます。ユーザーが要約を展開すると、ステップの説明が表示されます。もちろん、要約がある場合はその説明が表示されます。

ステップの詳細な説明。以下を含める必要があります。

デフォルトでは、ステップの説明はワークフローエディターで折りたたまれ、概要が表示されます。

利用可能なプラットフォームタイプは、 project_type_tags 属性。ステップがすべてのプラットフォームまたはプロジェクトタイプで利用できる場合は、指定しないでください project_type_tags。それ以外の場合は、ステップを使用できるすべてのプラットフォームタイプを選択してください。

使用可能な値は次のとおりです。

機能カテゴリは、 type_tags の属性 step.yml。 1つのステップには、単一のタイプタグのみを割り当てる必要があります。使用する utility 他のタイプのどれもあなたのステップに合わないとあなたが信じる場合にのみ。

使用可能な値は次のとおりです。

小文字を使用 スネークケース スタイル入力キー。例えば、 project_path。

入力はステップ実行プロセスでのみ公開されるため、入力キーにドメイン固有のプレフィックスを追加する必要はありません。これの意味は project_path 入力は後続のステップと重複しません ' project_path 入力。

ステップ入力値は文字列です。BitriseCLIは、ステップ入力を環境変数としてステップに公開します。

可能であれば（そしてそれが理にかなっている場合は）ステップ入力のデフォルト値を提供します。これにより、Bitriseユーザーはステップ構成が簡単になります。

次の場合を除いて、環境変数をデフォルト値として使用しないでください。

これは、ワークフローエディターが値のない必要な入力を強調表示して、ステップを表現するために、指定された入力に有効な値を設定しないと機能しないためです。自動的に割り当てられた値を持たない環境変数を入力のデフォルト値として設定すると、ワークフローエディターは、問題の必要な入力に有効な値が設定されていると見なします（デフォルトの環境変数にまだ値がない場合でも） ）。

また、この方法で環境変数に特定の名前を提案する理由はありません。ユーザーは、異なる名前の環境変数に同じ値が割り当てられている可能性があります。

ステップ入力がコードに渡される方法と、それらがどのように表示されるかについて説明しましょう。

ステップ入力には、ステップ自体と同じように、名前、要約、および説明を含めることができます。これらを定義するには：

これらがどのように見えるかを見てみましょう！

次に例を示します。

- install_defaults: "yes"
  opts:
    description: Installs default (Bitrise) Wildcard Provisioning Profile and
      Certificate files for testing.
    summary: Installs default (Bitrise) Wildcard code signing files.
    title: Installs default code signing files

それでは、ステップの他の構成オプションについて説明しましょう。

必要な入力には有効な値が必要です。そうでない場合、ステップは失敗します。

ステップ入力を必須としてマークするには、のis_requiredオプションを使用します opts 財産。 2つの値があります。 true と false。に設定されている場合 true、入力は次のように表示されます 必要 ワークフローエディタで。

- keychain_password: $BITRISE_KEYCHAIN_PASSWORD
  opts:
    title: "Keychain's password"
    is_required: true

ステップ入力をセンシティブとしてマークして、それらの値が公開されないようにすることができます。機密入力のみを受け入れます 秘密 値として。これにより、ビルドログに表示されなくなります。

ステップ入力を高感度としてマークするには、 is_sensitive のオプション opts 財産。 2つの値があります。 true と false。に設定されている場合 true、入力は次のように表示されます センシティブ ワークフローエディタで。

inputs:
  - certificate_urls: $BITRISE_CERTIFICATE_URL
    opts:
      title: "Certificate URL"
      is_sensitive: true

前述のように、任意の入力の値として環境変数を使用することができます。デフォルトでは、StepはEnv Varを展開し、その値をStepの実行に渡します。これはによって定義されます is_expand のオプション opts 財産。

- project_path: $BITRISE_PROJECT_PATH
  opts:
    is_expand: true

The is_expand オプションには、trueまたはfalseの2つの値を指定できます。に設定されている場合 true -これはデフォルトの動作です-、の値 $BITRISE_PROJECT_PATH ステップ実行に渡されます。に設定されている場合 false、文字列 $BITRISE_PROJECT_PATH 合格します（プロジェクトの場所が見つからないため、この特定のステップは失敗します）。

カテゴリオプションは、入力をグループ化するために使用されます。同じカテゴリに属する入力は一緒に表示され、ワークフローエディタではデフォルトで折りたたまれています。

- default_certificate_passphrase: $BITRISE_DEFAULT_CERTIFICATE_PASSPHRASE
  opts:
    category: Default code signing files
    description: |
      Certificate passphrase of the default certificate.
    is_sensitive: true
    title: Default certificate passphrase

この場合、この入力は、同じカテゴリが設定されている他のすべての入力とともに表示されます。

ステップに6つを超える入力がある場合は、カテゴリを使用できます。グループまたはルートで推奨される入力の最大数は6です。

ステップカテゴリを設計するときは、次の点に注意してください。

特定の入力の値のリストを受け入れることは絶対に可能です。これを行う場合は、入力のキーにリストサフィックスを追加することを強くお勧めします（たとえば、 input_path_list）、値が改行文字（\ n）で区切られたリストとして提供されることを期待します（たとえば、最初の値\ n2番目の値）。

値を区切るために本当に別の文字を使用する必要がない限り、このソリューションを使用してください。私たちの経験に基づくと、改行文字（\ n）は、入力値では非常にまれであるため（、、;、=または他のより一般的な区切り文字と比較して）、ユニバーサル区切り文字として非常にうまく機能します。

ベストプラクティスとして、空のアイテムを除外する必要があります。次のいずれかを使用します。

first value\n\nsecond value

また

first value\n       \nsecond value

出力キーには大文字を使用してください スネークケース スタイル出力キー。例：OUTPUT_PATH。

ステップ出力は、常に環境変数 (Env Var) としてエクスポートされます。たとえば、 Xcode のアーカイブと iOS へのエクスポートの手順 IPA ファイルを生成します。この出力は、 BITRISE_IPA_PATH 環境変数:

outputs:
- BITRISE_IPA_PATH:  
  opts:    
    title: .ipa file path   
    summary: Local path of the created .ipa file

例が示すように、出力定義にはキー (BITRISE_IPA_PATH) と opts また、タイトルと概要も含まれます。ワークフロー エディターでは、キーとタイトルがデフォルトで表示されます。これらは必須です。さらに、概要と説明を追加できます。

特定の出力の値のリストを提供することは絶対に可能です。これを行う場合は、出力のキーにLISTサフィックスを追加することを強くお勧めします（たとえば、 BITRISE_APK_PATH_LIST）、値が改行文字（\ n）で区切られたリストとして提供されることを期待します（たとえば、最初の値\ n2番目の値）。

値を区切るために本当に別の文字を使用する必要がない限り、このソリューションを使用してください。私たちの経験に基づくと、改行文字（\ n）は、入力値では非常にまれであるため（、、;、=または他のより一般的な区切り文字と比較して）、ユニバーサル区切り文字として非常にうまく機能します。

ステップリポジトリにバンドルする必要がある、ステップに必要なバイナリ、アセット、またはその他のものを保持する必要がある場合は、それらをステップリポジトリの横に含めることができます。 step.yml ファイルとステップのコード。 Bitrise CLIは、と呼ばれる環境変数を自動的にエクスポートします BITRISE_STEP_SOURCE_DIR これにより、いつでもこれらのファイルにアクセスできます。

たとえば、にアクセスできます .jar 次のように、ステップのリポジトリのルートにあるファイル：

$BITRISE_STEP_SOURCE_DIR/mytool.jar