Chapter 42. 通知プラグイン

The Gradle announce allows to send custom announcements during a build. The following notification systems are supported: 通知プラグインを使うと、ビルド実行中に通知を送信することができます。以下の通知システムがサポートされています。

42.1. 使用方法 Usage

To use the announce plugin, apply it to your build script:


Example 42.1. 通知プラグインを使用する


apply plugin: 'announce'

Next, configure your notification service(s) of choice (see table below for which configuration properties are available):


Example 42.2. 通知プラグインの設定


announce {  
  username = 'myId'
  password = 'myPassword'

Finally, send announcements with the announce method:


Example 42.3. 通知プラグインを使用する


task helloWorld << {  
    println "Hello, world!"

helloWorld.doLast {  
    announce.announce("helloWorld completed!", "twitter")
    announce.announce("helloWorld completed!", "local")

The announce method takes two String arguments: The message to be sent, and the notification service to be used. The following table lists supported notification services and their configuration properties.

announceメソッドは二つの引数を取ります。一つは通知メッセージで、もう一つは使用する通知用サービスです。 サポートされている通知用サービスとその設定値は以下の通りです。

Table 42.1. 通知プラグイン対応サービス Announce Plugin Notification Services

Notification Service 通知サービス Operating System オペレーティングシステム Configuration Properties 設定プロパティ Further Information 備考
twitter Any 何でも username, password
snarl Windows
growl Mac OS X
notify-send Ubuntu Requires the notify-send package to be installed. Use sudo apt-get install libnotify-bin to install it. notify-sendパッケージをインストールする必要があります。sudo apt-get install libnotify-binを実行してインストールしてください。
local Windows, Mac OS X, Ubuntu Automatically chooses between snarl, growl, and notify-send depending on the current operating system. snarl、growl、notify-sendの中から、オペレーティングシステムに応じて自動的に選択します。

42.2. 設定 Configuration

See AnnouncePluginExtension.