Scp
Uploads artifacts, files, and signatures to a SCP server.
Configuration
Legend:
-
required
-
optional
-
may use environment variable
-
accepts Name Templates
#
upload:
#
scp:
# 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 `scp`, i.e, `scpFoo`.
foo: bar
# Host where the SCP service is enabled.
#
host: uploads.acme.com
# Port number of SCP service.
# Defaults to `22`.
#
port: 22
# The username required for authorization.
#
username: __USE_ENVIRONMENT_VARIABLE__
# Password for login into the SCP 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.scp.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 `scp`, i.e, `scpFoo`.
# Host where the SCP service is enabled.
#
host = "uploads.acme.com"
# Port number of SCP service.
# Defaults to `port`.
#
port = 22
# The username required for authorization.
#
username = "__USE_ENVIRONMENT_VARIABLE__"
# Password for login into the SCP 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": {
//
"scp": {
// 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 `scp`, i.e, `scpFoo`.
"foo": "bar"
},
// Host where the SCP service is enabled.
// If left unspecified, the `JRELEASER_SCP_${name}_HOST`
// environment variable must be defined.
//
"host": "uploads.acme.com",
// Port number of SCP service.
// If left unspecified, the `JRELEASER_SCP_${name}_PORT`
// environment variable must be defined.
// Defaults to `22`.
//
"port": 22,
// The username required for authorization.
// If left unspecified, the `JRELEASER_SCP_${name}_USERNAME`
// environment variable must be defined.
//
"username": "__USE_ENVIRONMENT_VARIABLE__",
// Password for login into the SCP service.
// If left unspecified, the `JRELEASER_SCP_${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>
<!--
-->
<scp>
<!--
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 `scp`, i.e, `scpFoo`.
-->
<foo>bar</foo>
</extraProperties>
<!--
Host where the SCP service is enabled.
-->
<host>uploads.acme.com</host>
<!--
Port number of SCP service.
Defaults to `22`.
-->
<port>22</port>
<!--
The username required for authorization.
-->
<username>__USE_ENVIRONMENT_VARIABLE__</username>
<!--
Password for login into the SCP 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>
</scp>
</upload>
</jreleaser>
jreleaser {
//
upload {
//
scp {
// 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 `scp`, i.e, `scpFoo`.
//
extraProperties.put('foo', 'bar')
// Host where the SCP service is enabled.
//
host = 'uploads.acme.com'
// Port number of SCP service.
// Defaults to `22`.
//
port = 22
// The username required for authorization.
//
username = '__USE_ENVIRONMENT_VARIABLE__'
// Password for login into the SCP 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}}'
}
}
}
}
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.scp.${name}.active |
JRELEASER_UPLOAD_SCP_${name}_ACTIVE |
host |
|
jreleaser.upload.scp.${name}.host |
JRELEASER_UPLOAD_SCP_${name}_HOST |
port |
|
jreleaser.upload.scp.${name}.port |
JRELEASER_UPLOAD_SCP_${name}_PORT |
username |
|
jreleaser.upload.scp.${name}.username |
JRELEASER_UPLOAD_SCP_${name}_USERNAME |
password |
|
jreleaser.upload.scp.${name}.password |
JRELEASER_UPLOAD_SCP_${name}_PASSWORD |
publicKey |
|
jreleaser.upload.scp.${name}.public.key |
JRELEASER_UPLOAD_SCP_${name}_PUBLIC_KEY |
privateKey |
|
jreleaser.upload.scp.${name}.private.key |
JRELEASER_UPLOAD_SCP_${name}_PRIVATE_KEY |
passphrase |
|
jreleaser.upload.scp.${name}.passphrase |
JRELEASER_UPLOAD_SCP_${name}_PASSPHRASE |
fingerprint |
|
jreleaser.upload.scp.${name}.fingerprint |
JRELEASER_UPLOAD_SCP_${name}_FINGERPRINT |
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 |
|
|
foo bar |
|
|
foo-bar |
|
|
foo_bar |
|
|
foo.bar |
|
|
Path
The path 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
/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 Scp
and <name>
resolves to the capitalized name of the scp instance, such
that:
-
if the name is
foo
the resulting property key isskipUploadScpFoo
. -
if the name is
fooBar
the resulting property key isskipUploadScpFooBar
. -
if the name is
foo-bar
the resulting property key isskipUploadScpFooBar
.