Skip to main content

ビルドアノテーション

概要

Build Annotationsを使用すると、関連するビルド情報をBitriseのビルド詳細ページに直接追加できるため、ビルドの進行中やデバッグ中に重要なデータにアクセスするプロセスが簡単になります。

ビルド アノテーションを使用すると、関連するビルド情報を Bitrise ビルド詳細ページに直接追加できるため、ビルドの進行中やデバッグ中に重要なデータにアクセスするプロセスが簡素化されます。

注釈は、Markdown スタイルを使用して生成されます。いくつかの使用例は次のとおりです。

  • カスタム ツールの詳細なテスト結果。

  • 警告またはエラー メッセージを強調します。

  • セキュリティと脆弱性のスキャン レポート。

  • 静的分析レポート。

  • デプロイされたアーティファクトへのリンク。

ビルドに注釈を付ける

注釈を使用するには:

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

    例えば、 脚本 または 追い越し車線。

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

    bitrise plugin install https://github.com/bitrise-io/bitrise-plugins-annotations.git

  3. 使用 annotate 注釈を作成するプラグインのコマンド。

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

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

注釈のスタイルと書式設定

ビルド アノテーションは Markdown のスニペットです。スニペットの基本スタイルは、 --style アノテーションコマンドのフラグ。可能な値は次のとおりです。

  • default:

  • warning:

  • error:

annotation-styles.png

注釈はマークダウン構文を受け入れます。単純な書式設定に加えて、~ 文字または 4 つのスペースのインデントを使用したコード ブロックもサポートします。

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

bitrise :annotations annotate "
    This is also a codeblock
"

注釈には拡張可能な要素を追加できます。

annotations-expand.gif

  • コンテンツを次の場所に配置します 詳細 デフォルトではタグを付けると折りたたまれます。

  • カードをデフォルトで開いておきたい場合は、 詳細が開きます。。

  • を使う サマリー セクションの内容をユーザーに知らせるためのタグ。

  • 折りたたまれたセクションには、ヘッダー、画像、コードブロックなどを含めることができます。

<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>
このセクションの内容: