Skip to main content

ステップリファレンス/ IDフォーマット

概要

bitrise.ymlファイルでステップを参照するには、少なくともステップIDを含める必要があります。オプションで、StepLibソースとStepバージョンを指定することもできます。

A ステップ 参照には、次の3つのコンポーネントを含めることができます。

  1. StepLibソース：公式などのStepリポジトリのライブラリ ビットライズステップライブラリ。

  2. ステップID：すべてのステップには、その一部としてIDが必要です。 step.yml 意味。

  3. ステップバージョン：含めるステップの数値バージョン。

次の構文を使用して、ステップを参照します。

<step_lib_source>::<step-id>@<version>:

これらの3つのコンポーネントから、ステップIDのみが必要です。例えば：

- script:

これは次のように書くことができます：

https://github.com/bitrise-io/bitrise-steplib.git::[email protected]:

  • バージョンが定義されていない場合は、ステップの最新バージョンが使用されます。

  • StepLibソースが定義されていない場合、 default_step_lib_source 使用されます。

ステップの特定のバージョン（1.1.3など）を使用することをお勧めします。

特別なステップのソース

2つの特別なステップソースがあります。

  • git::

  • と path::

これらのソースのいずれかを使用すると、ステップはステップライブラリではなく、指定したIDデータによって識別されます。

git ::ソース

NS git:: sourceは、gitホスティングプロバイダーのステップのリポジトリです。 NS script ステップのGitHubソースは次のとおりです。 https://github.com/bitrise-io/steps-script。参照するには script gitリファレンスを直接ステップスルーすると、 git:: ソース、ステップのgit clone URL、およびリポジトリ内のブランチまたはタグ。

参照するには 1.1.3 スクリプトステップのリポジトリのバージョンタグ：

- git::https://github.com/bitrise-io/[email protected]:

一般に、ステップライブラリを介してステップバージョンを使用できる場合は常に、を使用する代わりにそれを行う必要があります。 git:: ソースの種類。ローカルステップキャッシング、ネットワークキャッシング、代替ダウンロードURLなどの機能は、StepLibで共有されるステップでのみサポートされます。

ただし、このタイプの参照では、StepLibを介して取得できない特定のことが可能になります。たとえば、 git:: ソースタイプは、ステップのまだ公開されていない状態または進行中の状態に使用できます。独自のステップを開発する場合は、これを使用できます git:: ステップをStepLibに公開する前に、ステップをテストするためのソースタイプ。

参照する soon-to-be-released ステップを開発しているリポジトリのブランチ：

- git::https://github.com/bitrise-io/steps-script.git@soon-to-be-released:

パス::ソース

NS path:: sourceは、ステップのリポジトリへのローカルパスを指定し、バージョン情報を必要としません。絶対ローカルパスと相対ローカルパスの両方がサポートされています。相対パスは、 bitrise.yml ファイル。

- path::/path/to/my/step:

- path::./relative/path:

これはステップ開発に役立ちます。アプリのソースコードにビルドステップを含めたい場合にも使用できます。

このセクションの内容:
ステップstep.yml