Ftp

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

Configuration

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.
      # 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 `ftp`, i.e, `ftpFoo`.
        foo: bar

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

      # Port number of FTP service.
      # Defaults to `21`.
      #  
      port: 21

      # The username required for authorization.
      #  
      username: __USE_ENVIRONMENT_VARIABLE__

      # Password for login into the FTP service.
      #  
      password: __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.ftp.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 `ftp`, i.e, `ftpFoo`.

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

  # Port number of FTP service.
  # Defaults to `port`.
  #  
  port = 21

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

  # Password for login into the FTP service.
  #  
  password = "__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": {
    // 
    "ftp": {
      // 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 `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": "__USE_ENVIRONMENT_VARIABLE__",

        // Password for login into the FTP service.
        // If left unspecified, the `JRELEASER_FTP_${name}_PASSWORD`
        // environment variable must be defined.
        //  
        "password": "__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>
    <!--
      
    -->
    <ftp>
      <!--
        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 `ftp`, i.e, `ftpFoo`.
          -->
          <foo>bar</foo>
        </extraProperties>

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

        <!--
          Port number of FTP service.
          Defaults to `21`.
           
        -->
        <port>21</port>

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

        <!--
          Password for login into the FTP service.
           
        -->
        <password>__USE_ENVIRONMENT_VARIABLE__</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.
        // 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 `ftp`, i.e, `ftpFoo`.
        // 
        extraProperties.put('foo', 'bar')

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

        // Port number of FTP service.
        // Defaults to `21`.
        //  
        port = 21

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

        // Password for login into the FTP service.
        //  
        password = '__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}}'
      }
    }
  }
}

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.upload.ftp.${name}.active
jreleaser.upload.ftp.active

JRELEASER_UPLOAD_FTP_${name}_ACTIVE
JRELEASER_UPLOAD_FTP_ACTIVE

host

jreleaser.upload.ftp.${name}.host
jreleaser.upload.ftp.host
jreleaser.ftp.${name}.host
jreleaser.ftp.host

JRELEASER_UPLOAD_FTP_${name}_HOST
JRELEASER_UPLOAD_FTP_HOST
JRELEASER_FTP_${name}_HOST
JRELEASER_FTP_HOST

port

jreleaser.upload.ftp.${name}.port
jreleaser.upload.ftp.port
jreleaser.ftp.${name}.port
jreleaser.ftp.port

JRELEASER_UPLOAD_FTP_${name}_PORT
JRELEASER_UPLOAD_FTP_PORT
JRELEASER_FTP_${name}_PORT
JRELEASER_FTP_PORT

username

jreleaser.upload.ftp.${name}.username
jreleaser.upload.ftp.username
jreleaser.ftp.${name}.username
jreleaser.ftp.username

JRELEASER_UPLOAD_FTP_${name}_USERNAME
JRELEASER_UPLOAD_FTP_USERNAME
JRELEASER_FTP_${name}_USERNAME
JRELEASER_FTP_USERNAME

password

jreleaser.upload.ftp.${name}.password
jreleaser.upload.ftp.password
jreleaser.ftp.${name}.password
jreleaser.ftp.password

JRELEASER_UPLOAD_FTP_${name}_PASSWORD
JRELEASER_UPLOAD_FTP_PASSWORD
JRELEASER_FTP_${name}_PASSWORD
JRELEASER_FTP_PASSWORD
Substitute ${name} for the value of the named instance.

Space (' '), underscore (_), and dash (-) will be replaced by dot (.) to separate tokens in the System property. Space (' '), dash (-), and dot (.) will be replaced by underscore (_) to separate tokens in the environment variable, such that:

${name} System Property Environment Variable

foobar

foobar

FOOBAR

fooBar

foobar

FOOBAR

foo bar

foo.bar

FOO_BAR

foo-bar

foo.bar

FOO_BAR

foo_bar

foo.bar

FOO_BAR

foo.bar

foo.bar

FOO_BAR

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.