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

Stepのプロパティリファレンス

Stepのプロパティは、プロジェクトの種類やソースコード、必要な依存関係など、Stepの重要なデータを提供します。Stepの入力と出力もStepのプロパティとして定義されています。それでは、プロパティを見ていきましょう。

  • title、summary、description: コメント、ツール、GUI向けのメタデータです。

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

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

  • website: Step/サービスの公式ウェブサイトです。

  • source_code_url: Stepのソースコードを閲覧できるURLです。

  • support_url: Stepのサポート/課題管理システムのURLです。

  • published_at: 共有時に自動生成 - StepのバージョンのStepLib公開日です。

  • source: 共有時に自動生成 - git cloneに関する情報です。

  • asset_urls: 共有時に自動生成 - アイコン画像など、Stepのアセット(StepLib固有)です。

  • host_os_tags: サポートされているオペレーティングシステムです。現在は未使用で、将来の使用のために予約されています。

  • project_type_tags: Stepが特定のプロジェクトタイプに固有の場合のプロジェクトタイプタグです。例: iosやandroid。完全に任意で、Stepの一覧での検索やフィルタリングにのみ使用されます。

  • type_tags: Stepに関連する汎用タイプタグです。例: utility、test、notification。project_type_tagsと同様に、このプロパティも完全に任意で、Stepの一覧での検索やフィルタリングにのみ使用されます。

  • deps: Stepに必要な依存関係を指定します。依存関係を宣言するには、パッケージマネージャーとインストールしたい依存関係を指定してください。

  • dependencies: depsに代わる、より新しい汎用的な方法です。必要な依存関係をmanager/nameのペアのリストとして指定します。

  • toolkit: Stepの実行方法(たとえばbashスクリプトやgoバイナリとして)とそのエントリーポイントを指定します。

  • inputs: Stepの入力(環境変数)です。

  • outputs: Stepの出力(環境変数)です。