GitHub

独自のStepを作成・シェアする

独自のStepを作成するには、bitrise CLI (v1.6.1以上) を用意する必要があります。BashまたはGoツールキットを使用してStepを生成することができます。

Bitrise CLIが未インストールの場合、ここでインストールガイドを確認してください。

最新のBitrise CLIを使用してください!

最新のBitrise CLI、もしくは最低でもバージョン1.6.1以上のCLIであることに注意してください。bitrise --versionを呼び出してBitrise CLIバージョン情報を確認することができます。これはCLIがStepを作成するのに:stepプラグインを使用するのが理由で、このプラグインはコアプラグインとしてバージョン1.6.1から導入されています。

Stepの作成

Bitrise CLIのインストールが完了すれば、3つの簡単なコマンドを使って自己流のStepを作成することができます。

# If this is the very first time you use the CLI / if you just installed the CLI run this:
bitrise setup

# If you want to update the Step plugin to the latest version:
bitrise plugin update step

# And to generate a new Step, simply run this command and follow the guide it prints:
bitrise :step create

コマンド無しでbitrise :stepを動作させると、プラグインのヘルプをプリントします。

完了すれば、step.ymlmain.go (Goの場合) かstep.sh (Bashの場合) ファイルを新規のStepレポジトリに入れます。

生成されたStepのREADMEには以下の説明が含まれています:

Stepの構成に進む前に

知っておくべき重要ポイントを確認してください!

Step開発ガイドライン

新しく作成されたStepは’Skelton (スケルトン)’と呼ばれます:step.ymlファイルでは、特定のプロパティがデフォルト値で割り当てられており、インプットとアウトプットの例がデフォルト値の構造を示すために作成されます。

例えばStepをシェアする場合、多くのStepプロパティが自動的に生成されますが、必要に応じて他のプロパティを手動で設定する必要があります。プラグインを使って新規のStepを作成する時、project_type_tags プロパティのみ、デフォルトではいくつかの値が不足しています。こういった場合、step.ymlファイル内で全てのプロパティを手動で修正することができます。

StepのインプットならびにアウトプットはStepプロパティでもあります。詳細については、Step properties, Step inputs, Step outputsをご覧ください。

規定に名前をつける:バージョニング, Step ID, Stepインプット・アウトプット

Stepでの環境変数について

**Stepのコードに直接、環境変数を使わないでください。**代わりに、Stepのインプットとして全ての外的変数をエクスポーズ (公開)して、ご使用になりたい環境変数へインプットのデフォルト値をセットします。このアクションはstep.ymlファイルにて行うことができます。この方法により、Stepのテストがより簡単になり、Stepのユーザーは必要な変数のコードを精査せずに容易にインプットを宣言することができます。

例:

xcode-archiveStepはアウトプット環境変数$BITRISE_IPA_PATHを生成します。Step内で以下のようなインプットを作成してください:

inputs:
  - ipa-path: $BITRISE_IPA_PATH
    opts:
      title: "IPA path"

Stepでのシークレット環境変数

StepインプットをSensitiveにマークして、valuesが公開されないようにすることができます。Sensitiveインプットは値として、Secrets (シークレット環境変数) のみ許可します。これでビルドログで表示されることはありません。

is_sensitiveプロパティを使用してStepインプットをSensitiveにマークします。このプロパティには2つの値が存在します:truefalse

is_expand プロパティ

Sensitiveにマークを入れると、is_expandプロパティのインプットは、trueである必要があります (デフォルトで設定されています)。

inputs:
  - certificate_urls: $BITRISE_CERTIFICATE_URL
    opts:
      title: "Certificate URL"
      is_sensitive: true

サブモジュールと依存

**サブモジュールを使用したり、Step内でオンデマンドでダウンロードした他リソースを要求しないでください。**StepのレポジトリにStepに必要なものを全て収納するようにしてください。ネットワークエラーや認証問題などによりリソースのダウンロードが失敗する可能性があります。

サブモジュールについては、レポジトリのサブモジュールとして使用するのではなく、他のレポジトリのコンテンツを含めるようにします。

しかし、OSの dependency managerからフェッチが可能な依存を宣言することができます (例:apt-getbrew)。依存の宣言についての情報は、Stepプロパティをご覧ください。

他にもご質問がある方は、Bitriseのcommunity discussion siteを覗いてみましょう。お問い合わせはこちらから。

新しいStepのアイデアがほしいですか?リストがありますので、こちらからヒントを得てください :)

新Stepのシェア

全世界のユーザーに新しく作成したStepを共有したいですか?簡単なセットアップでシェアできるようになっています!

コマンド bitrise shareを使って開始するのを推奨します。Stepのシェアについてのガイドをプリントするようになっているので、これをお使いください!コマンドラインインターフェースを開始する前に確認したい方もいるので、ここでも重要な情報をまとめます。

  1. パブリックgitレポジトリにStepが保管されていることを確認します。
  2. Fork the StepLib repository you want to have your step in. We recommend using the The official Bitrise StepLib!
    Stepを管理したいStepLibレポジトリをフォークします。BitriseオフィシャルStepLibを使用するのをお勧めします!
  3. シェアするのに、ローカルでフォークされたStepLibを準備します:

    $ bitrise share start -c https://github.com/[your-username]/bitrise-steplib.git
    
  4. Stepのレポジトリにstep version tagを追加します。
  5. フォークされたStepLibレポジトリにStepを追加します:

    $ bitrise share create --tag [step-version-tag] --git [step-git-uri].git --stepid [step-id]
    
  6. オプションで、フォークされたStepLib上のヘルスチェックを行うことができます:

    $ bitrise audit -c https://github.com/[your-username]/bitrise-steplib.git
    
  7. オリジナルのStepLibレポジトリにプルリクエストを作成します。

これで完了です!いったんプルリクエストがマージされると、選択したStepLibレポジトリを使用する人であれば誰でも使用することができます。