Ftp

Uploads artifacts, files, and signatures to a FTP server.

Legend:

  • required

  • optional

  • may use environment variable

  • accepts Name Templates

  • YAML

  • TOML

  • JSON

  • Maven

  • Gradle

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

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

      # 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

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

      # Host where the FTP service is enabled.
      # If left unspecified, the `JRELEASER_FTP_${name}_HOST`
      # environment variable must be defined.
      #  
      host: uploads.acme.com

      # Port number of FTP service.
      # If left unspecified, the `JRELEASER_FTP_${name}_PORT`
      # environment variable must be defined.
      # Defaults to `21`.
      #  
      port: 21

      # The username required for authorization.
      # If left unspecified, the `JRELEASER_FTP_${name}_USERNAME`
      # environment variable must be defined.
      #  
      username: __DO_NOT_SET_HERE__

      # Password for login into the FTP service.
      # If left unspecified, the `JRELEASER_FTP_${name}_PASSWORD`
      # environment variable must be defined.
      #  
      password: __DO_NOT_SET_HERE__

      # 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.ftp.app]

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

  # 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

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

  # Host where the FTP service is enabled.
  # If left unspecified, the `JRELEASER_FTP_${name}_HOST`
  # environment variable must be defined.
  #  
  host = "uploads.acme.com"

  # Port number of FTP service.
  # If left unspecified, the `JRELEASER_FTP_${name}_PORT`
  # environment variable must be defined.
  # Defaults to `port`.
  #  
  port = 21

  # The username required for authorization.
  # If left unspecified, the `JRELEASER_FTP_${name}_USERNAME`
  # environment variable must be defined.
  #  
  username = "__DO_NOT_SET_HERE__"

  # Password for login into the FTP service..
  # If left unspecified, the `JRELEASER_FTP_${name}_PASSWORD`
  # environment variable must be defined.
  #  
  password = "__DO_NOT_SET_HERE__"

  # 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": {
    // 
    "ftp": {
      // Uploaders require a name.
      // 
      "app": {

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

        // 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,

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

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

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

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

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

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

        <!--
          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>

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

        <!--
          Host where the FTP service is enabled.
          If left unspecified, the `JRELEASER_FTP_${name}_HOST`
          environment variable must be defined.
           
        -->
        <host>uploads.acme.com</host>

        <!--
          Port number of FTP service.
          If left unspecified, the `JRELEASER_FTP_${name}_PORT`
          environment variable must be defined.
          Defaults to `21`.
           
        -->
        <port>21</port>

        <!--
          The username required for authorization.
          If left unspecified, the `JRELEASER_FTP_${name}_USERNAME`
          environment variable must be defined.
           
        -->
        <username>__DO_NOT_SET_HERE__</username>

        <!--
          Password for login into the FTP service.
          If left unspecified, the `JRELEASER_FTP_${name}_PASSWORD`
          environment variable must be defined.
           
        -->
        <password>__DO_NOT_SET_HERE__</password>

        <!--
          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>
    </ftp>
  </upload>
</jreleaser>
jreleaser {
  // 
  upload {
    // 
    ftp {
      // Uploaders require a name.
      // 
      app {

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

        // 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

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

        // Host where the FTP service is enabled.
        // If left unspecified, the `JRELEASER_FTP_${name}_HOST`
        // environment variable must be defined.
        //  
        host = 'uploads.acme.com'

        // Port number of FTP service.
        // If left unspecified, the `JRELEASER_FTP_${name}_PORT`
        // environment variable must be defined.
        // Defaults to `21`.
        //  
        port = 21

        // The username required for authorization.
        // If left unspecified, the `JRELEASER_FTP_${name}_USERNAME`
        // environment variable must be defined.
        //  
        username = '__DO_NOT_SET_HERE__'

        // Password for login into the FTP service.
        // If left unspecified, the `JRELEASER_FTP_${name}_PASSWORD`
        // environment variable must be defined.
        //  
        password = '__DO_NOT_SET_HERE__'

        // 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}}'
      }
    }
  }
}

Host

You can have the host set in the configuration as shown above, or you can have it read from an environment variable. The configured name of the FTP server will be used to build the environment variable name. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_FTP_NAME_HOST. If your instance is named production, you can store the host in the environment variable JRELEASER_FTP_PRODUCTION_HOST. The name will be transformed to uppercase.

If a configured host is found in the configuration file, then the environment variable is not used at all.

Port

You can have the port set in the configuration as shown above, or you can have it read from an environment variable. The configured name of the FTP server will be used to build the environment variable name. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_FTP_NAME_PORT. If your instance is named production, you can store the port in the environment variable JRELEASER_FTP_PRODUCTION_PORT. The name will be transformed to uppercase.

If a configured port is found in the configuration file, then the environment variable is not used at all.

Username

You can have the username set in the configuration as shown above, or you can have it read from an environment variable. The configured name of the FTP server will be used to build the environment variable name. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_FTP_NAME_USERNAME. If your instance is named production, you can store the username in the environment variable JRELEASER_FTP_PRODUCTION_USERNAME. The name will be transformed to uppercase.

If a configured username is found in the configuration file, then the environment variable is not used at all.

Password

The password will be stored in an environment variable. The configured name of the FTP server will be used. This means that the name per configured instance needs to be unique.

The name of the environment variable will be JRELEASER_FTP_NAME_PASSWORD. If your instance is named production, you need to store the secret in the environment variable JRELEASER_FTP_PRODUCTION_PASSWORD. The name will be transformed to uppercase.

Path

The path (relative to the authenticated or anonymous user) where artifacts will be uploaded to.

An example configuration may look like path: 'uploads/{{projectName}}/{{tagName}}/{{artifactFile}}'.

And will result in a final deployment like ftp://:/uploads/app/v1.0.0/app-1.0.0.zip.

DownloadUrl

The downloadUrl is the URL used to download artifacts from. This property is optional but should be set if artifacts are available for download.

An example configuration may look like downloadUrl: 'https://artifacts.acme.com:8081/upload/{{projectName}}/{{tagName}}/{{artifactFile}}'.

And will result in a final URL like https://artifacts.acme.com:8081/upload/app/v1.0.0/app-1.0.0.zip.

Skip Upload

Distributions and Artifacts may define extra properties that may stop them from being uploaded. These properties must conform to the following rules:

  • skipUpload: skipped from all uploaders.

  • skipUpload<type>: skipped from the typed uploader.

  • skipUpload<type><name>: skipped from the typed and named uploader.

Where <type> resolves to Ftp and <name> resolves to the capitalized name of the ftp instance, such that:

  • if the name is foo the resulting property key is skipUploadFtpFoo.

  • if the name is fooBar the resulting property key is skipUploadFtpFooBar.

  • if the name is foo-bar the resulting property key is skipUploadFtpFooBar.