Teams

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 Teams room. You must create a custom webhook for this announcer to work.

Log into Teams.
Click on the Apps icon.
Click on the Connectors menu item.
Click on Incoming Webhook and add it to a team.
Configure the 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_TEAMS_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:
  # 
  teams:
    # Enables or disables Teams.
    # 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 `teams`, i.e, `teamsFoo`.
      foo: bar

    # The webhook associated with a specific Teams room.
    #  
    webhook: __USE_ENVIRONMENT_VARIABLE__

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

# 
[announce.teams]
  # Enables or disables Teams.
  # 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 `teams`, i.e, `teamsFoo`.

  # The webhook associated with a specific Teams room.
  #  
  webhook = "__USE_ENVIRONMENT_VARIABLE__"

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

{
  // 
  "announce": {
    // 
    "teams": {
      // Enables or disables Teams.
      // 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 `teams`, i.e, `teamsFoo`.
        "foo": "bar"
      },

      // The webhook associated with a specific Teams room.
      //  
      "webhook": "__USE_ENVIRONMENT_VARIABLE__",

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

<jreleaser>
  <!--
    
  -->
  <announce>
    <!--
      
    -->
    <teams>
      <!--
        Enables or disables Teams.
        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 `teams`, i.e, `teamsFoo`.
        -->
        <foo>bar</foo>
      </extraProperties>

      <!--
        The webhook associated with a specific Teams room.
         
      -->
      <webhook>__USE_ENVIRONMENT_VARIABLE__</webhook>

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

jreleaser {
  // 
  announce {
    // 
    teams {
      // Enables or disables Teams.
      // 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 `teams`, i.e, `teamsFoo`.
      //  
      extraProperties.put('foo', 'bar')

      // The webhook associated with a specific Teams room.
      //  
      webhook = '__USE_ENVIRONMENT_VARIABLE__'

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

The message must follow the Adaptive Card format.

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.teams.active	JRELEASER_ANNOUNCE_TEAMS_ACTIVE
webhook
jreleaser.announce.teams.webhook jreleaser.teams.webhook	JRELEASER_ANNOUNCE_TEAMS_WEBHOOK JRELEASER_TEAMS_WEBHOOK

System Property

Environment Variable

active

jreleaser.announce.teams.active

JRELEASER_ANNOUNCE_TEAMS_ACTIVE

webhook

jreleaser.announce.teams.webhook
jreleaser.teams.webhook

JRELEASER_ANNOUNCE_TEAMS_WEBHOOK
JRELEASER_TEAMS_WEBHOOK