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

Stepの参照/ID形式

Step参照には、3つの要素を含めることができます。

  1. StepLibソース: Stepリポジトリのライブラリです。たとえば公式のBitrise Step Libraryなどです。
  2. Step ID: すべてのStepには、step.yml定義の一部としてIDが必要です。
  3. Stepバージョン: 含めるStepの数値バージョンです。

次の構文を使用してStepを参照します。

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

これら3つの要素のうち、必須なのはStep IDのみです。例:

- script:

これは次のように記述できます。

https://github.com/bitrise-io/bitrise-steplib.git::script@1:
  • バージョンが定義されていない場合は、ステップのlatest versionが使用されます。
  • StepLibソースが定義されていない場合は、default_step_lib_sourceが使用されます。

Stepを参照する際は、メジャーバージョンを固定することをお勧めします。上記の例では、script@1はScriptStepのメジャーバージョン1が固定されていることを意味します。つまり、StepはStepの利用可能な最新のマイナーバージョンおよびパッチバージョンで実行されます。たとえば、最新のマイナーバージョンが1.2、最新のパッチバージョンが1.2.2の場合、メジャーバージョン1を固定すると、Stepはバージョン1.2.2を使用することになります。

特殊なStepソースClick to copy link​

特殊なStepソースには次の2つがあります。

  • git::
  • path::

これらのソースのいずれかを使用する場合、StepはStep Libraryではなく、指定したIDデータによって識別されます。

git::ソースClick to copy link​

git::ソースは、gitホスティングプロバイダー上にあるStepのリポジトリです。scriptStepのGitHubソースはhttps://github.com/bitrise-io/steps-scriptです。gitリファレンスを使用してscriptStepを直接参照するには、git::ソース、Stepのgit cloneURL、およびリポジトリ内のブランチまたはタグを使用します。

scriptStepのリポジトリの1.1.3バージョンタグを参照するには:

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

一般に、Step Libraryを通じてStepバージョンを使用できる場合は、git::ソースタイプを使用するのではなく、そちらを使用することをお勧めします。ローカルステップキャッシュ、ネットワークキャッシュ、代替ダウンロードURLなどの機能は、StepLibで共有されているStepsでのみサポートされます。

ただし、この種の参照方法を使用すると、StepLibでは得られない特定のメリットが得られます。たとえば、git::ソースタイプは、まだ公開されていない、または開発中のStepの状態に使用できます。独自のStepを開発している場合は、このgit::ソースタイプを使用して、StepLibに公開する前にステップをテストできます。

Stepを開発しているリポジトリのsoon-to-be-releasedブランチを参照するには:

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

path::ソースClick to copy link​

path::ソースは、Stepのリポジトリへのローカルパスを指定するもので、バージョン情報は不要です。絶対パスと相対パスの両方がサポートされています。相対パスは、bitrise.ymlファイルを含むフォルダを基準とした相対パスです。

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

- path::./relative/path:

これはStepの開発に役立ちます。また、ビルドStepsをプロジェクトのソースコードに含めたい場合にも使用できます。

関連情報