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

Step inputsリファレンス

Stepの入力は、Bitrise CLIが特定のStepをどのように実行するかを伝える環境項目です。Stepの入力は、すべてのStepのstep.ymlファイルでinputsプロパティを設定することによって定義されます。

Step inputsは、すべての環境プロパティと同じ構文を持ちます。これは、KEY: valueのペアとoptsフィールドという2つの主要な部分で構成されます。

inputs:
- my_key_for_the_env: "default value" 
  opts: 
    title: An example env var item 
    is_dont_change_value: false 
    category: example
  • my_key_for_the_env: 入力のキー(必須)。
  • default value: 入力のdefault value。default valueを必ず指定する必要はありません。
  • opts: 任意のプロパティ。

Step input propertiesClick to copy link​

  • title、summary、description: コメント、ツール、GUI用のメタデータ。

    永続的なコメントとしてのメタプロパティ

    これらのメタプロパティは、永続的なコメントとして使用できます。標準のYMLコメントは、YMLが正規化されたり、JSONに変換されたり、その他の方法で生成・変換されたりする際に保持されませんが、これらのメタプロパティは保持されます。

  • is_expand: trueまたはfalseに設定できます。default valueはtrueであるため、Bitrise CLIはStepに渡す前にEnvironment Variables(環境変数)を展開します。つまり、Stepの入力値が環境変数である場合、Bitrise CLIはその変数の値をStepに渡します。falseに設定されている場合、CLIは環境変数のキーを文字列として渡します。

  • skip_if_empty: trueまたはfalseに設定できます。trueに設定した場合、値が空であればその入力は使用されません。

  • category: 入力を分類するために使用します。同じcategoryを持つ入力は、利便性のためウェブサイトのUI上で1つのメニューにまとめて表示されます。

  • value_options: 使用可能な値のリスト。

  • is_required: trueまたはfalseに設定できます。trueに設定した場合、そのステップでは入力に空でない値を設定する必要があります。

  • is_dont_change_value: trueまたはfalseに設定できます。trueに設定すると、入力の値は変更されない、またはUI上で非表示になります。主にデバッグ用の入力や、このStepを別のものと接続するために他のStepsの出力に設定する「connection」入力に使用されます。

  • is_template: trueまたはfalseに設定できます。trueに設定すると

    、

    入力の値はGoテンプレートとして評価されます。

  • is_sensitive: 入力をsensitiveとしてマークすると、その値としてSecret環境変数のみを受け付けるようになります。パスワード、APIキー、トークンなどの機密情報に最もよく使用されますが、どの入力もsensitiveとしてマークできます。

Step inputsにテンプレート式を使用するClick to copy link​

特定の状況でのみStepに特定の値を使用させたい場合は、Step inputsとしてテンプレート式を使用します。テンプレート式は、Stepが入力を使用する前に評価されます。これらはGoのテンプレート言語で記述します。

テンプレート式を使用するには、プロジェクトのstep.ymlファイルでis_templateプロパティを設定します。

  1. プロジェクトのstep.ymlファイルを開きます。
  2. テンプレート式を使用したいStepを見つけます。
  3. Stepのcontentにoptsフィールドを追加します。
  4. optsにis_templateプロパティを追加し、その値をtrueに設定します。
  5. Stepのcontentにテンプレート式を追加します。
Bitrise CLIがCIモードかどうかを確認する 
- script:
  title: Template example
  inputs:
  - content: |-
      {{if .IsCI}}
      echo "CI mode"
      {{else}}
      echo "not CI mode"
      {{end}}
    opts:
      is_template: true

関連情報