Sftp

# 
upload:
  # 
  sftp:
    # Uploaders require a name.
    # 
    app:

      # Enables or disables the uploader.
      # 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

      # Upload files.
      # Defaults to `true`.
      # 
      files: true

      # Upload distribution artifacts.
      # Defaults to `true`.
      # 
      artifacts: true

      # Release checksum files.
      # Defaults to `true`.
      # 
      checksums: true

      # Upload signatures.
      # Defaults to `true`.
      # 
      signatures: true

      # Upload catalogs.
      # Defaults to `true`.
      # 
      catalogs: true

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

      # Host where the SFTP service is enabled.
      #  
      host: uploads.acme.com

      # Port number of SFTP service.
      # Defaults to `22`.
      #  
      port: 22

      # The username required for authorization.
      #  
      username: __USE_ENVIRONMENT_VARIABLE__

      # Password for login into the SFTP service.
      #  
      password: __USE_ENVIRONMENT_VARIABLE__

      # The public SSH key.
      #  
      publicKey: __USE_ENVIRONMENT_VARIABLE__

      # The private SSH key.
      #  
      privateKey: __USE_ENVIRONMENT_VARIABLE__

      # The passphrase required to read private keys.
      #  
      passphrase: __USE_ENVIRONMENT_VARIABLE__

      # The remote server's SSH fingerprint.
      #  
      fingerprint: __USE_ENVIRONMENT_VARIABLE__

      # Path where artifacts will be uploaded.
      #  
      path: '/uploads/{{projectName}}/{{tagName}}/{{artifactFile}}'

      # An HTTP/HTTPS URL from where artifacts may be downloaded.
      #  
      downloadUrl: 'https://download.acme.com/{{projectName}}/{{tagName}}/{{artifactFile}}'

# Uploaders require a name.
# 
[upload.sftp.app]

  # Enables or disables the uploader.
  # 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

  # Upload files.
  # Defaults to `true`.
  # 
  files = true

  # Upload distribution artifacts.
  # Defaults to `true`.
  # 
  artifacts = true

  # Release checksum files.
  # Defaults to `true`.
  # 
  checksums = true

  # Upload signatures.
  # Defaults to `true`.
  # 
  signatures = true

  # Upload catalogs.
  # Defaults to `true`.
  # 
  catalogs = true

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

  # Host where the SFTP service is enabled.
  #  
  host = "uploads.acme.com"

  # Port number of SFTP service.
  # Defaults to `port`.
  #  
  port = 22

  # The username required for authorization.
  #  
  username = "__USE_ENVIRONMENT_VARIABLE__"

  # Password for login into the SFTP service.
  #  
  password = "__USE_ENVIRONMENT_VARIABLE__"

  # The public SSH key.
  #  
  publicKey = "__USE_ENVIRONMENT_VARIABLE__"

  # The private SSH key.
  #  
  privateKey = "__USE_ENVIRONMENT_VARIABLE__"

  # The passphrase required to read private keys.
  #  
  passphrase = "__USE_ENVIRONMENT_VARIABLE__"

  # The remote server's SSH fingerprint.
  #  
  fingerprint = "__USE_ENVIRONMENT_VARIABLE__"

  # Path where artifacts will be uploaded.
  #  
  path = "/uploads/{{projectName}}/{{tagName}}/{{artifactFile}}"

  # An HTTP/HTTPS URL from where artifacts may be downloaded.
  #  
  downloadUrl = "https://download.acme.com/{{projectName}}/{{tagName}}/{{artifactFile}}"

{
  // 
  "upload": {
    // 
    "sftp": {
      // Uploaders require a name.
      // 
      "app": {

        // Enables or disables the uploader.
        // 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,

        // Upload files.
        // Defaults to `true`.
        // 
        "files": true,

        // Upload distribution artifacts.
        // Defaults to `true`.
        // 
        "artifacts": true,

        // Release checksum files.
        // Defaults to `true`.
        // 
        "checksums": true,

        // Upload signatures.
        // Defaults to `true`.
        // 
        "signatures": true,

        // Upload catalogs.
        // Defaults to `true`.
        // 
        "catalogs": true,

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

        // Host where the SFTP service is enabled.
        // If left unspecified, the `JRELEASER_SFTP_${name}_HOST`
        // environment variable must be defined.
        //  
        "host": "uploads.acme.com",

        // Port number of SFTP service.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PORT`
        // environment variable must be defined.
        // Defaults to `22`.
        //  
        "port": 22,

        // The username required for authorization.
        // If left unspecified, the `JRELEASER_SFTP_${name}_USERNAME`
        // environment variable must be defined.
        //  
        "username": "__USE_ENVIRONMENT_VARIABLE__",

        // Password for login into the SFTP service.
        // If left unspecified, the `JRELEASER_SFTP_${name}_PASSWORD`
        // environment variable must be defined.
        //  
        "password": "__USE_ENVIRONMENT_VARIABLE__",

        // The public SSH key.
        //  
        "publicKey": "__USE_ENVIRONMENT_VARIABLE__",

        // The private SSH key.
        //  
        "privateKey": "__USE_ENVIRONMENT_VARIABLE__",

        // The passphrase required to read private keys.
        //  
        "passphrase": "__USE_ENVIRONMENT_VARIABLE__",

        // The remote server's SSH fingerprint.
        //  
        "fingerprint": "__USE_ENVIRONMENT_VARIABLE__",

        // Path where artifacts will be uploaded.
        //  
        "path": "/uploads/{{projectName}}/{{tagName}}/{{artifactFile}}",

        // An HTTP/HTTPS URL from where artifacts may be downloaded.
        //  
        "downloadUrl": "https://download.acme.com/{{projectName}}/{{tagName}}/{{artifactFile}}"
      }
    }
  }
}

<jreleaser>
  <!--
    
  -->
  <upload>
    <!--
      
    -->
    <sftp>
      <!--
        Uploaders require a name.
        
      -->
      <app>
        <!--
          Enables or disables the distribution.
          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>

        <!--
          Upload files.
          Defaults to `true`.
          
        -->
        <files>true</files>

        <!--
          Upload distribution artifacts.
          Defaults to `true`.
          
        -->
        <artifacts>true</artifacts>

        <!--
          Release checksum files.
          Defaults to `true`.
          
        -->
        <checksums>true</checksums>

        <!--
          Upload signatures.
          Defaults to `true`.
          
        -->
        <signatures>true</signatures>

        <!--
          Upload catalogs.
          Defaults to `true`.
          
        -->
        <catalogs>true</catalogs>

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

        <!--
          Host where the SFTP service is enabled.
           
        -->
        <host>uploads.acme.com</host>

        <!--
          Port number of SFTP service.
          Defaults to `22`.
           
        -->
        <port>22</port>

        <!--
          The username required for authorization.
           
        -->
        <username>__USE_ENVIRONMENT_VARIABLE__</username>

        <!--
          Password for login into the SFTP service.
           
        -->
        <password>__USE_ENVIRONMENT_VARIABLE__</password>

        <!--
          The public SSH key.
           
        -->
        <publicKey>__USE_ENVIRONMENT_VARIABLE__</publicKey>

        <!--
          The private SSH key.
           
        -->
        <privateKey>__USE_ENVIRONMENT_VARIABLE__</privateKey>

        <!--
          The passphrase required to read private keys.
           
        -->
        <passphrase>__USE_ENVIRONMENT_VARIABLE__</passphrase>

        <!--
          The remote server's SSH fingerprint.
           
        -->
        <fingerprint>__USE_ENVIRONMENT_VARIABLE__</fingerprint>

        <!--
          Path where artifacts will be uploaded.
           
        -->
        <path>/uploads/{{projectName}}/{{tagName}}/{{artifactFile}}</path>

        <!--
          An HTTP/HTTPS URL from where artifacts may be downloaded.
           
        -->
        <downloadUrl>https://download.acme.com/{{projectName}}/{{tagName}}/{{artifactFile}}</downloadUrl>
      </app>
    </sftp>
  </upload>
</jreleaser>

jreleaser {
  // 
  upload {
    // 
    sftp {
      // Uploaders require a name.
      // 
      app {

        // Enables or disables the uploader.
        // 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

        // Upload files.
        // Defaults to `true`.
        // 
        files = true

        // Upload distribution artifacts.
        // Defaults to `true`.
        // 
        artifacts = true

        // Release checksum files.
        // Defaults to `true`.
        // 
        checksums = true

        // Upload signatures.
        // Defaults to `true`.
        // 
        signatures = true

        // Upload catalogs.
        // Defaults to `true`.
        // 
        catalogs = true

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

        // Host where the SFTP service is enabled.
        //  
        host = 'uploads.acme.com'

        // Port number of SFTP service.
        // Defaults to `22`.
        //  
        port = 22

        // The username required for authorization.
        //  
        username = '__USE_ENVIRONMENT_VARIABLE__'

        // Password for login into the SFTP service.
        //  
        password = '__USE_ENVIRONMENT_VARIABLE__'

        // The public SSH key.
        //  
        publicKey = '__USE_ENVIRONMENT_VARIABLE__'

        // The private SSH key.
        //  
        privateKey = '__USE_ENVIRONMENT_VARIABLE__'

        // The passphrase required to read private keys.
        //  
        passphrase = '__USE_ENVIRONMENT_VARIABLE__'

        // The remote server's SSH fingerprint.
        //  
        fingerprint = '__USE_ENVIRONMENT_VARIABLE__'

        // Path where artifacts will be uploaded.
        //  
        path: '/uploads/{{projectName}}/{{tagName}}/{{artifactFile}}'

        // An HTTP/HTTPS URL from where artifacts may be downloaded.
        //  
        downloadUrl: 'https://download.acme.com/{{projectName}}/{{tagName}}/{{artifactFile}}'
      }
    }
  }
}