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

StepsをすべてのBitriseユーザーと共有する

Stepが他の人の役に立つと思われる場合は、共有できます。ただし、共有する前に、同じ問題を解決する他のStepsがないことを確認してください。以下を確認できます。

特定の機能が不足しているStepを見つけた場合は、その機能のために新しいStepを開発または共有する前に、既存のものへの貢献を試みてください。Integrationsページを使用すると、Bitrise StepLib内のStepsを検索できます。特定のStepのページにあるGitHub sourceボタンをクリックすると、Stepのリポジトリに移動し、そこで機能リクエストの送信やプルリクエストのオープンができます。

また、共有されたStepsは積極的にメンテナンスされ、コントリビューターに対してオープンである必要がある点にご注意ください。

新しいStepを共有するClick to copy link​

共有プロセスは比較的シンプルですが、新しいStepを共有する際は、手順を注意深く確認するようにしてください。

bitrise step shareコマンド

Stepの開発中は、bitrise step shareを実行するだけで、いつでもヘルプを確認できます。これにより、共有に関する簡単なガイドが表示されます。

Stepを共有する方法は2つあります。

  • bitrise step shareコマンドを使用して手動で行う方法。
  • StepプラグインでStepを作成した場合は、Stepのディレクトリでshare-this-step Workflowを実行する方法。

開始する前にClick to copy link​

開始する前に、以下を確認してください。

  • Stepが公開Gitリポジトリにあること。
  • step.ymlファイルに、有効なIssueトラッカー(たとえばStepのGitHubリポジトリのIssuesページなど)を指すsupport_urlプロパティが含まれていること。
  • step.ymlファイルに、リポジトリの正しいGit URLを指すsource_code_urlプロパティが含まれていること。
複数のStepを共有する

複数のStepを共有する場合、つまりBitrise StepLibに複数の新しいstep.ymlファイルを追加する場合は、それぞれ別のプルリクエストで行う必要があります。1つのプルリクエストに複数の新しいStepを含めることはできません。

準備ができたら、お好みの共有方法を進めてください。

bitrise step shareコマンドで共有するClick to copy link​

  1. Bitrise StepLibリポジトリをフォークします。

  2. 共有のために、フォークしたStepLibをローカルで準備します。

    $ bitrise step share start -c <https://github.com/[your-username]/bitrise-steplib.git>

  3. StepのリポジトリにStepのバージョンタグを追加します。

  4. フォークしたStepLibリポジトリにStepを追加します。

    $ bitrise step share create --tag [step-version-tag] --git [step-git-uri].git --stepid [step-id]

  5. 必要に応じて、フォークしたStepLibの完全なヘルスチェックを実行します。

    $ bitrise step share audit -c <https://github.com/[your-username]/bitrise-steplib.git>

  6. Stepのstep.ymlファイルを確認し、問題がなければ共有プロセスを完了します。これにより、step.ymlファイルがフォークしたStepLibリポジトリにコミットおよびプッシュされます。

    $ bitrise step share finish

    これにより、step.ymlファイルがフォークしたStepLibリポジトリにコミットおよびプッシュされます。

  7. 公式のBitrise StepLibリポジトリでプルリクエストを開きます。

share-this-step Workflowで共有するClick to copy link​

share-this-step Workflowは、Stepプラグインを使用して新しいStepを作成する際に自動生成されるbitrise.ymlファイルに含まれています。これを使用すると、Stepの共有が非常に簡単になります。

  1. Bitrise StepLibリポジトリをフォークします。

  2. bitrise.ymlファイルで、必要なWorkflow Environment VariablesをアプリレベルのEnvironment Variablesとして設定します。

    app:
      envs:
      - BITRISE_STEP_ID:
      - BITRISE_STEP_VERSION:
      - BITRISE_STEP_GIT_CLONE_URL:
      - MY_STEPLIB_REPO_FORK_GIT_URL:

  3. Bitrise CLIでshare-this-step Workflowを実行します。

    $ bitrise local run share-this-step

StepLibのプルリクエストで問題を修正するClick to copy link​

StepのバージョンをStepLibに送信したら、Bitriseチームによるレビューをお待ちください。変更を依頼された場合は、以下の手順に従ってください。

  1. プルリクエストをクローズします。
  2. フォークしたBitrise StepLibからshareブランチを削除します。
  3. Stepリポジトリで問題を修正します。
  4. Stepリポジトリで、修正内容を含むコミットに新しいバージョンタグを追加します。
  5. 共有プロセスをもう一度実行します。

問題を修正していただければ、プルリクエストをマージし、Stepを一般公開できるようになるはずです。

Stepアイコンを追加するClick to copy link​

StepにStepアイコンを追加できます。追加すると、Workflow EditorおよびIntegrationsページに表示されます。これは任意です。Stepを公式のBitrise Step Libraryに追加したい場合にのみ、アイコンが必要になります。以下の要件があります。

  • 背景色を透明にしないでください。
  • サイズ: 256x256 px。
  • マージン: 60 px。
  • 形式: SVG。

Stepのアイコンを送信するには:

  • フォークしたStepLibリポジトリのSTEPLIB_FORK_ROOT/steps/YOUR_STEP_ID/assets/icon.svgに.svgファイルを追加します。
  • StepLibリポジトリに新しいプルリクエストを作成します。

放棄されたStepsClick to copy link​

Stepのメンテナーである場合、Stepに対してissueやプルリクエストが送信された際は、妥当な期間内に対応できるようにしてください。Stepの重要な修正や更新に関して複数回連絡を試みても数週間にわたって返答がない場合、コレクション内のStepを非推奨にしたり、削除または置き換えたりすることがあります。放棄されたStepsは、それを利用するユーザーにとって脅威となる可能性があるため、Stepを他の人と共有する際はこの点にご注意ください。

Bitrise StepLib内のstep.ymlには、リポジトリとissueトラッカーへの恒久的なリンクが含まれているため、これらを削除しないでください。削除された場合でも、共有プロセス中にBitriseが管理するファイルホスティングサービスにも共有されているため、既に共有されたStepのバージョンは引き続き機能します。Bitriseが管理する新しいバージョンのステップがリリースされる場合があります。

Stepを共有したものの、メンテナンスを継続できない、または継続する意思がなくなった場合は、次のリポジトリでGitHub issueを作成してください: Bitrise StepLib

Stepの問題を報告するClick to copy link​

重大な(セキュリティまたは機能面の)問題があるStepを使用している場合は、StepのIssue Trackerでチケットを作成してください。すべてのStepは、support_url属性で問題報告の推奨方法を宣言しています。

Stepのメンテナーから長期間(数週間以上)返答がない場合は、次のリポジトリでGitHub issueを作成してください: https://github.com/bitrise-io/bitrise-steplib。問題は「放棄されたStep」ポリシーに従って解決を試みます。このコレクションに貢献するすべての人は、利用可能なStepを提供することであなたを助けようとしていることをご理解の上、しばらくお待ちください。

関連情報