Mastodon

Posts a status to a Mastodon server.

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

# 
announce:
  # 
  mastodon:
    # Enables or disables Mastodon.
    # Valid 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 `mastodon`, i.e, `mastodonFoo`.
      foo: bar

    # The Mastodon server.
    # 
    host: https://my.mastodonserver.org

    # The access token to use.
    # If left unspecified, the `JRELEASER_MASTODON_ACCESS_TOKEN`
    # environment variable must be defined.
    #  
    accessToken: __DO_NOT_SET_HERE__

    # The announcement status.
    # Review the available Name Templates.
    #  
    status: '🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}'
# 
[announce.mastodon]
  # Enables or disables Mastodon.
  # Valid 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 `mastodon`, i.e, `mastodonFoo`.

  # The Mastodon server.
  # 
  host = "https://my.mastodonserver.org"

  # The access token to use.
  # If left unspecified, the `JRELEASER_MASTODON_ACCESS_TOKEN`
  # environment variable must be defined.
  #  
  accessToken = "__DO_NOT_SET_HERE__"

  # The announcement status.
  # Review the available Name Templates.
  #  
  status = "🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}"
{
  // 
  "announce": {
    // 
    "mastodon": {
      // Enables or disables Mastodon.
      // Valid 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 `mastodon`, i.e, `mastodonFoo`.
        "foo": "bar"
      },

      // The Mastodon server.
      // 
      "host": "https://my.mastodonserver.org",

      // The access token to use.
      // If left unspecified, the `JRELEASER_MASTODON_ACCESS_TOKEN`
      // environment variable must be defined.
      //  
      "accessToken": "__DO_NOT_SET_HERE__",

      // The announcement status.
      // Review the available Name Templates.
      //  
      "status": "🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}"
    }
  }
}
<jreleaser>
  <!--
    
  -->
  <announce>
    <!--
      
    -->
    <mastodon>
      <!--
        Enables or disables Mastodon.
        Valid 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 `mastodon`, i.e, `mastodonFoo`.
        -->
        <foo>bar</foo>
      </extraProperties>

      <!--
        The Mastodon server.
        
      -->
      <host>https://my.mastodonserver.org</host>

      <!--
        The access token to use.
        If left unspecified, the `JRELEASER_MASTODON_ACCESS_TOKEN`
        environment variable must be defined.
         
      -->
      <accessToken>__DO_NOT_SET_HERE__</accessToken>

      <!--
        The announcement status.
        Review the available Name Templates.
         
      -->
      <status>🚀 {{projectNameCapitalized}} {{projectVersion}} has been released! {{releaseNotesUrl}}</status>
    </mastodon>
  </announce>
</jreleaser>
jreleaser {
  // 
  announce {
    // 
    mastodon {
      // Enables or disables Mastodon.
      // Valid 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 `mastodon`, i.e, `mastodonFoo`.
      //  
      extraProperties.put('foo', 'bar')

      // The Mastodon server.
      // 
      host = 'https://my.mastodonserver.org'

      // The access token to use.
      // If left unspecified, the `JRELEASER_MASTODON_ACCESS_TOKEN`
      // environment variable must be defined.
      //  
      accessToken = '__DO_NOT_SET_HERE__'

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