gradle-ssh-plugin

Released on 2016-05-14

• #221 Groovy SSH 2.1.1
• Kaizen
  • Improve stream interaction performance (especially SCP GET and PUT)

Released on 2016-05-07

• #217 Groovy SSH 2.1.0
• New features
  • SCP get and put (thanks to @jordihs, @sdavids13)
  • New stream interaction

Released on 2016-04-01

• #211 Groovy SSH 2.0.0
• New features
  • Add sudoPassword setting (thanks to @johnjaylward)
  • Add sudoPath setting (thanks to @ashrafmr)
  • Add agentForwarding setting (thanks to @dantonini)
  • Improve most settings can be set per remote
• Kaizen
  • Refactor settings inheritance

Released on 2016-03-24

• #209 Groovy SSH 1.6.0
• New feature
  • Add agent forwarding feature (thanks to @dantonini)

Released on 2016-03-20

• #207 Groovy SSH 1.5.1
• Bug fixes
  • #206 Fix remove method fails if any file or directory does not exist (thanks to @mvysny, @centic9)
  • Fix sftp method always returns null

Released on 2016-03-13

• #200 Groovy SSH 1.5.0
• New feature
  • #199 Add allRoles() to remote container (thanks to @matthiasbalke)
• Kaizen
  • #201 Use role implementation of Groovy SSH
  • #203 Remove deprecated

Released on 2016-03-06

• #197 Groovy SSH 1.4.0
• New feature
  • #55 Add ECDSA host key support (thanks to @ymnk)
• Kaizen
  • Improve log messages

Released on 2016-02-26

• #195 Groovy SSH 1.3.0
• New feature
  • #185 Add remove file or directory method (thanks to @craigburke and @mvysny)
• Kaizen
  • Refactor SFTP recursion
  • Refactor sudo trait

Released on 2016-02-09

• #192 Groovy SSH 1.2.0
• New feature
  • Identity can be set as a File or String (thanks to @PatrickHuetter)
• Kaizen
  • Fix for Groovy 2.4
  • Compliant with Semantic Versioning 2.0.0

Released on 2016-02-07

• #189 Groovy SSH 1.1.9
• Bug fix
  • Fix infinite loop if SFTP subsystem is disabled
• Kaizen
  • #182 Bump to Gradle 2.10

Released on 2015-11-01

• #177 Groovy SSH 1.1.8
• Bug fix
  • Fix retry connection mechanism (broken since 1.1.2)

Released on 2015-05-14

• #160 Groovy SSH 1.1.7
• New Feature
  • Add SSH keep-alive setting (interval 60 seconds by default)
• Bug fix
  • Fix typo in the usage banner

Released on 2015-03-30

• #154 Groovy SSH 1.1.6
• New Feature
  • ECDSA user key support
• Kaizen
  • Improve error messages of the container builder

Note that ECDSA host key in known_hosts is not supported yet. Please contact me if you faced any problems.

Released on 2015-02-26

• #149 Groovy SSH 1.1.5
• New Feature
  • Map based DSL extension system

ssh.settings {
  extensions.add restartAppServer: {
    execute "/opt/${project.name}/tomcat/bin/shutdown.sh"
    execute "/opt/${project.name}/tomcat/bin/startup.sh"
  }
}
ssh.run {
  session(ssh.remotes.testServer) {
    restartAppServer()
  }
}

No backward compatibility change

A trait extension can not access to the project now. Instead use a map extension. #148 has been removed.

Released on 2015-02-25

• #147 Bump to Groovy SSH 1.1.4
• New Feature
  • Port forwarding support
  • #148 Give access to the project in an extension
• Kaizen
  • Improve log readability
  • Trait based DSL extension system

No backward compatible change

DSL extension system is changed from mixin to trait. Older extensions may work but should be migrated to traits. See the document for details.

Note that extensions must be placed in the buildSrc/src/main/groovy directory.

Released on 2015-02-11

• #143 Bump to Groovy SSH 1.0.7
• Kaizen
  • Fix compatibility for Gradle 1.x (that is Groovy 1.8.6)
  • Add acceptance test on Gradle 1.12

How to Use on Gradle 1.x

Add Groovy backports library as follows:

buildscript {
    repositories {
        jcenter()
    }
    dependencies {
        classpath "org.hidetake:gradle-ssh-plugin:1.0.5"
        classpath 'org.codehaus.groovy:groovy-backports-compat23:2.3.6'
    }
}

Released on 2015-02-08

• #143 Bump to Groovy SSH 1.0.6
• New Feature
  • Ignore the exit status of the remote command or shell by the ignoreError setting

// do not raise error even if the command returns non-zero exit status
execute 'exit 1', ignoreError: true

// do not raise error even if the command returns non-zero exit status
executeBackground 'exit 1', ignoreError: true

// do not raise error even if the command returns non-zero exit status
executeSudo 'exit 1', ignoreError: true

// do not raise error even if the shell returns non-zero exit status
shell ignoreError: true, interaction: {...}

Released on 2015-02-07

• #142 Bump to Groovy SSH 1.0.5
• New Feature
  • Add the new syntax to get the content of the remote file.
• Kaizen
  • Change syntax of put() for symmetric design.

New feature

get() supports following options now.

// specify a file path or File object
get from: '/remote/file', into: 'local_file'
get from: '/remote/file', into: buildDir

// specify an output stream
file.withOutputStream { stream ->
  get from: '/remote/file', into: stream
}

// get content as a string
def text = get from: '/remote/file'

No backward compatible change

Some syntax of put() is replaced with from:.

Old syntax:

put file: 'test.txt', into: '/tmp'
put file: new File('test.txt'), into: '/tmp'
put files: [new File('test.txt')], into: '/tmp'
put stream: stream, into: '/tmp/test.dat'

is replaced with new syntax:

put from: 'test.txt', into: '/tmp'
put from: new File('test.txt'), into: '/tmp'
put from: [new File('test.txt')], into: '/tmp'
put from: stream, into: '/tmp/test.dat'

See the user guide for details.

Released on 2015-02-04

• #140 Bump to Groovy SSH 1.0.3
• New Feature
  • Add the new syntax to put a content into the remote file. See the user guide for details.

// specify a file path, File object or Interable<File>
put file: 'local_file', into: '/remote/file'
put file: buildDir, into: '/remote/folder'
put files: files('local_file1', 'local_file2'), into: '/remote/folder'

// specify a string
put text: 'hello world', into: '/remote/script.sh'

// specify a byte array
put bytes: [0xff, 0xff] as byte[], into: '/remote/fixture.dat'

Released on 2015-01-05

• #137 Bump to Groovy SSH 1.0.1
• Kaizen
  • #138 Change default logging method to stdout and make easy to find problems
  • Fix hostname does not appear in console log if logging is set to stdout