ステップ入力リファレンス

ステップ入力は、特定のステップを実行する方法をBitriseCLIに指示する環境項目です。ステップの入力は、 step.yml を設定することにより、すべてのステップのファイル inputs 財産..

ステップ入力の構文は、すべての環境プロパティと同じです。これは、2つの主要な部分で構成されています。 KEY: value ペアと opts 分野。

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:入力のデフォルト値。常にデフォルト値を指定する必要はありません。

  • opts:オプションのプロパティ。

ステップ入力プロパティ

ステップ入力で使用可能なプロパティ:

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

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

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

  • is_expand :に設定できます true また false。デフォルト値は true そのため、Bitrise CLIは、ステップに渡す前に環境変数(Env Vars)を展開します。つまり、ステップ入力の値がEnv Varの場合、BitriseCLIは変数の値をステップに渡します。に設定されている場合 false、CLIはEnvVarのキーを文字列として渡します。

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

  • category :入力を分類するために使用されます。同じ入力 category 便宜上、WebサイトのUIの1つのメニューにグループ化されて表示されます。

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

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

  • is_dont_change_value :に設定できます true また false。に設定されている場合 true、入力の値を変更したり、UIで非表示にしたりしないでください。主にデバッグ入力と「繋がり」入力(このステップを別のステップに接続するために、他のステップの出力に設定されます)。

  • is_template :に設定できます true また false。に設定されている場合 true

    ,

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

  • is_sensitive:入力を機密としてマークすることは、その値としてシークレット環境変数のみを受け入れることを意味します。パスワード、APIキー、トークンなどの機密情報に最も頻繁に使用されますが、入力はすべて機密としてマークできます。

ステップ入力にテンプレート式を使用する

特定の状況でのみ特定の値を使用するためにステップが必要な場合は、テンプレート式をステップ入力として使用します。テンプレート式は、ステップが入力を使用する前に評価されます。彼らはで書かれています Goのテンプレート言語

をセットする is_template のプロパティ step.yml テンプレート式を使用するプロジェクトのファイル。

  1. を開きます step.yml プロジェクトのファイル。

  2. テンプレート式を使用するステップを見つけます。

  3. 追加します opts フィールドに content ステップの。

  4. 追加します is_template プロパティに opts その値をに設定します true

  5. テンプレート式をステップに追加します content

例1 BitriseCLIがCIモードになっているかどうかの確認
- script:
  title: Template example
  inputs:
  - content: |-
      {{if .IsCI}}
      echo "CI mode"
      {{else}}
      echo "not CI mode"
      {{end}}
    opts:
      is_template: true