Gradle Knappsack Plugin

This plug-in provides means to connect to a Knappsack server to perform artifact deployment. It handles authentication and supports SSL connections as well. All operations are performed using plain HTTP requests.

Example build.gradle:

apply plugin: 'knappsack'

knappsack {
    url = 'https://knappsack.sample.com'
    userName = 'DeployBot'
    password = 'qwerty' // Only for presentation purposes! :-)
    applicationId = 1
    groupId = 2
    storageId = 3
    version = '1.2.3'
    whatsNew = 'Recent changes in version 1.2.3'
    artifactFileName = 'build/application.ipa'

    keyStoreFileName = 'cacerts'
    keyStorePassword = 'azerty'
}

gradle knappsackUpload

Example command line usage:

gradle knappsackUpload -Pknappsack.url='https://knappsack.sample.com' -Pknappsack.user.name='DeployBot' -Pknappsack.password='qwerty' -Pknappsack.app.id=1 -Pknappsack.group.id=2 -Pknappsack.storage.id=3 -Pknappsack.version='1.2.3' -Pknappsack.whatsNew='Recent changes in version 1.2.3' -Pknappsack.artifact='build/application.ipa' -Pknappsack.keystore.file='cacerts' -Pknappsack.keystore.password='azerty'

knappsack extension parameters:

url

required: yes
property: knappsack.url
Knappsack server URL. Both HTTP and HTTPS connections are supported.

userName

required: yes
property: knappsack.user.name
User credential for authentication with Knappsack.

password

required: yes
property: knappsack.user.password
User password for authentication with Knappsack.

applicationId

required: yes
property: knappsack.app.id
Application id the artifact belongs to.

groupId

required: yes
property: knappsack.group.id
Group id the artifact should be available to.

storageId

required: yes
property: knappsack.storage.id
Storage id where the artifact should be kept.

version

required: yes
property: knappsack.version
Artifact version.

whatsNew

required: yes when whatsNewFileName is not defined
property: knappsack.whatsnew
The message desribing recent changes in the application version. This parameter can not be used with whatsNewFileName.

whatsNewFileName

required: yes when whatsNew is not defined
property: knappsack.whatsnew.file
A file name containing the message decribing recent changed in the application version. This parameter can not be used with whatsNew.

artifactFileName

required: yes
property: knappsack.artifact
A file name of the artifact file to upload.

keyStoreFileName

required: no
property: knappsack.keystore.file
The file name of a key store to use for HTTPS connections to the server. When the keyStoreFileName parameter is defined the given key store is used instead of the default one. This feature can be used when the Knappsack server uses a self-signed ceritficate and you don't want to modify the default Java key store.

keyStorePassword

required: yes if keyStoreFileName is defined
property: knappsack.keystore.password
A password for the key store file.