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

ビルドアノテーション

ビルドアノテーションを使用すると、Bitrise build detailsページに関連するビルド情報を直接追加できるため、ビルドの進行中やデバッグ時に重要なデータへアクセスする作業が簡単になります。

アノテーションはMarkdownのスタイルを使用して生成されます。主なユースケースは次のとおりです。

  • カスタムツールの詳細なテスト結果
  • 警告やエラーメッセージの強調
  • セキュリティおよび脆弱性スキャンレポート
  • 静的解析レポート
  • デプロイされたアーティファクトへのリンク

ビルドへのアノテーションの追加Click to copy link​

アノテーションを使用するには、次の手順を行います。

  1. カスタムコマンドを実行できるStepを追加します。

    例:Scriptやfastlaneなど。

  2. Bitrise Annotationsプラグインをインストールするコマンドを追加します。

    bitrise plugin install https://github.com/bitrise-io/bitrise-plugins-annotations.git
  3. アノテーションを作成するには、プラグインのannotateコマンドを使用します。

    このコマンドは次の形式で動作します:bitrise :annotations annotate [markdown] [flags]。これはデフォルトスタイルの基本的なMarkdownアノテーションです。

    bitrise :annotations annotate "**My Annotation**"

アノテーションのスタイルと書式設定Click to copy link​

ビルドアノテーションはMarkdownのスニペットです。このスニペットの基本スタイルは、アノテーションコマンドの--styleフラグによって決まります。指定できる値は次のとおりです。

  • info(デフォルトのスタイル)
  • success
  • warning
  • error

アノテーションはMarkdown構文に対応しています。単純な書式設定に加えて、~文字または4つのスペースによるインデントを使用したコードブロックにも対応しています。

bitrise :annotations annotate "
~~~
This is a codeblock
~~~
"

bitrise :annotations annotate "
This is also a codeblock
"

アノテーションには、展開可能な要素を追加できます。

annotations-expand.gif

  • コンテンツをdetailsタグ内に配置すると、デフォルトで折りたたまれます。
  • カードをデフォルトで開いた状態にしたい場合は、details openを使用します。
  • summaryタグを使用して、セクション内に何が含まれているかをユーザーに知らせます。
  • 折りたたまれたセクション内には、見出し、画像、コードブロックなどを含めることができます。
<details>

<summary>Example summary</summary>

### You can add a header

You can add text within a collapsed section.

You can add an image or a code block, too.

</details>