19.7. Git フック通知のカスタマイズ

Business Central には、フックの終了コードをもとに、カスタマイズした Git フック通知をユーザーが受信可能なメカニズムがあります。

この通知メカニズムを有効にするには、カスタムのメッセージを含む *.properties ファイルを作成してから、appformer.git.hooks.bundle システムプロパティーの値として対象のファイルのパスを指定する必要があります。

手順

  1. *.properties ファイルを作成して、各終了コードに以下の形式の適切なメッセージを 1 行追加してください。

    <exit_code>=<display_message>

    <exit_code> は、Git フックの終了コードに、<display_message> はユーザーに表示するカスタムメッセージに置き換えます。

    以下に例を示します。

    0=Success! All working as expected.
    1=Warning! Please check the logs and advise your admin.
    .
    .
    31=Error! Please advise your admin immediately.
    注記

    考えられる終了コードをすべて *.properties ファイルに定義する必要はありません。*.properties ファイルに定義されている終了コードに対する通知のみが表示されます。

    重要

    通知サービスは、プロパティーファイルに設定されている ISO 8859-1 (LATIN 1) 文字のみサポートします。拡張文字を使用する場合には、Unicode 文字コードのエスケープシーケンスを使用してください。

  2. Git フック通知を有効化するには、appformer.git.hooks.bundle システムプロパティーの値としてファイルへのパスを指定します。

    Messages.properties ファイルを参照する設定が含まれている、以下の standalone.xml ファイル例を確認してください。

    <system-properties>
      <property name="appformer.git.hooks.bundle" value="/opt/jboss-as/git-hooks-messages/Messages.properties">
      </property>
      ...
    </system-properties>

19.7.1. Business Central の Git フック通知

Business Central で Git フックの通知を確認できます。Git フックの終了コードの通知タイプは 3 種類あります。

表19.2 Git フックの UI 通知タイプ

終了コードカスタマイズしたメッセージUI での通知の色

0

Success!All working as expected. (成功 ! すべて想定どおりに機能しています。)

Green

1 から 30

Warning!Please check the logs and advise your admin. (警告 ! ログを確認して管理者に連絡してください。)

Orange

31 から 255

Error!Please advise your admin immediately. (エラー ! 今すぐ管理者に連絡してください。)

Red

重要

UNIX マシンがサポートするエラーコードは 0 (success) から 255 (error) までで、この範囲外の終了コードは別のコードに変換され、誤った通知メッセージが表示される可能性があります。

Windows マシンには、制限がなく、幅広い終了コードをサポートします。