Discord

This announcer has been deprecated in v1.4.0 and will be removed in v2.0.0. Use Webhooks instead as shown here.

Posts a message to a Discord room. You must create a custom webhook for this announcer to work.

Log into the target discord server.
Select the channel you want to integrate to, click on its settings icon.
Click on the Integrations menu item.
Click on Webhooks.
Create a new webhook.
Copy the generated webhook URL.

Webhooks are not protected, anyone with access to the webhook URI can send messages to the target room. Prefer setting the JRELEASER_DISCORD_WEBHOOK environment variable over explicitly setting a value in the configuration DSL.

Configuration

Legend:

required
optional
may use environment variable
accepts Name Templates

YAML
TOML
JSON
Maven
Gradle

# 
announce:
  # 
  discord:
    # Enables or disables discord.
    # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
    # Defaults to `NEVER`.
    #  
    active: ALWAYS

    # Defines the connection timeout in seconds.
    # Defaults to `20`.
    # 
    connectTimeout: 20

    # Defines the read timeout in seconds.
    # Defaults to `60`.
    # 
    readTimeout: 60

    # Additional properties used when evaluating templates.
    #  
    extraProperties:
      # Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`.
      foo: bar

    # The webhook associated with a specific Discord room.
    # If left unspecified, the `JRELEASER_DISCORD_WEBHOOK`
    # environment variable must be defined.
    #  
    webhook: __USE_ENVIRONMENT_VARIABLE__

    # The announcement message.
    # Review the available Name Templates.
    #  
    message: '🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}'

    # Path to a template file that contains the message.
    # Review the available Name Templates.
    # Defaults to `src/jreleaser/templates/discord.tpl`.
    # 
    messageTemplate: path/to/template/discord.tpl

# 
[announce.discord]
  # Enables or disables discord.
  # Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
  # Defaults to `NEVER`.
  #  
  active = "ALWAYS"

  # Defines the connection timeout in seconds.
  # Defaults to `20`.
  # 
  connectTimeout = 20

  # Defines the read timeout in seconds.
  # Defaults to `60`.
  # 
  readTimeout = 60

  # Additional properties used when evaluating templates.
  #  
  extraProperties.foo = "bar"
  # Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`.

  # The webhook associated with a specific Discord room.
  # If left unspecified, the `JRELEASER_DISCORD_WEBHOOK`
  # environment variable must be defined.
  #  
  webhook = "__USE_ENVIRONMENT_VARIABLE__"

  # The announcement message.
  # Review the available Name Templates.
  #  
  message = "🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}"

  # Path to a template file that contains the message.
  # Review the available Name Templates.
  # Defaults to `src/jreleaser/templates/discord.tpl`.
  # 
  messageTemplate = "path/to/template/discord.tpl"

{
  // 
  "announce": {
    // 
    "discord": {
      // Enables or disables discord.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `NEVER`.
      //  
      "active": "ALWAYS",

      // Defines the connection timeout in seconds.
      // Defaults to `20`.
      // 
      "connectTimeout": 20,

      // Defines the read timeout in seconds.
      // Defaults to `60`.
      // 
      "readTimeout": 60,

      // Additional properties used when evaluating templates.
      //  
      "extraProperties": {
        // Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`.
        "foo": "bar"
      },

      // The webhook associated with a specific Discord room.
      // If left unspecified, the `JRELEASER_DISCORD_WEBHOOK`
      // environment variable must be defined.
      //  
      "webhook": "__USE_ENVIRONMENT_VARIABLE__",

      // The announcement message.
      // Review the available Name Templates.
      //  
      "message": "🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}",

      // Path to a template file that contains the message.
      // Review the available Name Templates.
      // Defaults to `src/jreleaser/templates/discord.tpl`.
      // 
      "messageTemplate": "path/to/template/discord.tpl"
    }
  }
}

<jreleaser>
  <!--
    
  -->
  <announce>
    <!--
      
    -->
    <discord>
      <!--
        Enables or disables discord.
        Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
        Defaults to `NEVER`.
         
      -->
      <active>ALWAYS</active>

      <!--
        Defines the connection timeout in seconds.
        Defaults to `20`.
        
      -->
      <connectTimeout>20</connectTimeout>

      <!--
        Defines the read timeout in seconds.
        Defaults to `60`.
        
      -->
      <readTimeout>60</readTimeout>

      <!--
        Additional properties used when evaluating templates.
         
      -->
      <extraProperties>
        <!--
          Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`.
        -->
        <foo>bar</foo>
      </extraProperties>

      <!--
        The webhook associated with a specific Discord room.
        If left unspecified, the `JRELEASER_DISCORD_WEBHOOK` environment variable must be defined.
         
      -->
      <webhook>__USE_ENVIRONMENT_VARIABLE__</webhook>

      <!--
        The announcement message.
        Review the available Name Templates.
         
      -->
      <message>🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}</message>

      <!--
        Path to a template file that contains the message.
        Review the available Name Templates.
        Defaults to `src/jreleaser/templates/discord.tpl`.
        
      -->
      <messageTemplate>path/to/template/discord.tpl</messageTemplate>
    </discord>
  </announce>
</jreleaser>

jreleaser {
  // 
  announce {
    // 
    discord {
      // Enables or disables discord.
      // Supported values are [`NEVER`, `ALWAYS`, `RELEASE`, `SNAPSHOT`].
      // Defaults to `NEVER`.
      //  
      active = 'ALWAYS'

      // Defines the connection timeout in seconds.
      // Defaults to `20`.
      // 
      connectTimeout = 20

      // Defines the read timeout in seconds.
      // Defaults to `60`.
      // 
      readTimeout = 60

      // Additional properties used when evaluating templates.
      // Key will be capitalized and prefixed with `discord`, i.e, `discordFoo`.
      //  
      extraProperties.put('foo', 'bar')

      // The webhook associated with a specific Discord room.
      // If left unspecified, the `JRELEASER_DISCORD_WEBHOOK`
      // environment variable must be defined.
      //  
      webhook = '__USE_ENVIRONMENT_VARIABLE__'

      // The announcement message.
      // Review the available Name Templates.
      //  
      message = '🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}'

      // Path to a template file that contains the message.
      // Review the available Name Templates.
      // Defaults to `src/jreleaser/templates/discord.tpl`.
      // 
      messageTemplate = 'path/to/template/discord.tpl'
    }
  }
}

You may define either message or messageTemplate, with the former taking precedence over the latter.

Environment

When not explicitly set, the value of the following properties may be resolved from an environment variable or a system property as shown in the table. The system property takes precedence over the environment variable.

System Property	Environment Variable
active
jreleaser.announce.discord.active	JRELEASER_ANNOUNCE_DISCORD_ACTIVE
webhook
jreleaser.announce.discord.webhook jreleaser.discord.webhook	JRELEASER_ANNOUNCE_DISCORD_WEBHOOK JRELEASER_DISCORD_WEBHOOK

System Property

Environment Variable

active

jreleaser.announce.discord.active

JRELEASER_ANNOUNCE_DISCORD_ACTIVE

webhook

jreleaser.announce.discord.webhook
jreleaser.discord.webhook

JRELEASER_ANNOUNCE_DISCORD_WEBHOOK
JRELEASER_DISCORD_WEBHOOK