Skip to main content

ビルドアノテーション

概要

Build Annotations allow you to add relevant build information directly on the Bitrise build details page, simplifying the process of accessing crucial data during build progression and debugging.

ビルド アノテーションを使用すると、関連するビルド情報を 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
"
このセクションの内容: