diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..54ae72f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,76 @@ +### Changelog + +##### Version 2.6.1 (April 13 2018) + +- \[JENKINS-19973\] Option to hide ssh command in log + +##### Version 2.6 (April 7 2018) + +- \[JENKINS-46172\] Handle NPE when not all fields are specified & save only properly configured sites +- \[JENKINS-10128\] Set build to UNSTABLE when no SSH site is configured instead of NPE +- Add Jenkinsfile to plugin +- bump ssh-credentials dependency to 1.12 +- Add ajax validation to essential ssh host fields + +INFO: the "Add Credentials" button for SSH Site **don't work** in recent Jenkins 2.x versions - this will be fixed in upcoming 3.0 version. +(major version since plugin will have to migrate it's configuration to new format) + +##### Version 2.5 (July 8 2017) + +- \[JENKINS-21436\] Integrate with the SSH Credentials Plugin; previous credentials are migrated +- \[JENKINS-23231\] Add timeout parameter +- \[JENKINS-24913\] Don't show sensitive build variables in console log +- \[JENKINS-12191\] Restore resolving hostname from environment variables +- \[JENKINS-12191\] Support build variables (substitution variables) during command execution (env variables are exported before the script) +- \[JENKINS-24402\] Updated to latest version of JSch (0.1.54) to support modern algorithms +- Pull JSch dependency via Jenkins hosted jsch-plugin to use recommended way of getting common dependencies in Jenkins +- Set Jenkins 1.609.3 as the oldest supported version +- Show warning for missing parameters during ajax form validation +- Fix security issue + +Due to added integration with SSH Credentials Plugin, **this version might NOT be fully compatibile** with previous version. Sorry! + +Please **back up your `org.jvnet.hudson.plugins.SSHBuildWrapper.xml` before upgrading to version 2.5.** + +##### Version 2.4 (Jan 08 2014) + +- ability to use variables when defining SSH host +- miscellaneous fixes +- added keep alive interval + +##### Version 2.3 (Sep 24 2012) + +- fixed [JENKINS-15265](https://issues.jenkins-ci.org/browse/JENKINS-15265) + +##### Version 2.2 (Sep 03 2012) + +- fixed[JENKINS-15005](https://issues.jenkins-ci.org/browse/JENKINS-15005) and [JENKINS-14420](https://issues.jenkins-ci.org/browse/JENKINS-14420) + +##### Version 2.1 (Aug 14 2012) + +- configurable pty mode + +##### Version 2.0 (Jun 26, 2012) + +- support multiple sites on the same machine + +##### Version 1.6 (Jun 24, 2012) + +- support parameterized builds + +##### Version 1.3 (Jun 25, 2011) + +- Run script on build step. +- Fixed [JENKINS-9240](https://issues.jenkins-ci.org/browse/JENKINS-9240) + +##### Version 1.2 (Feb 17, 2011) + +- Fix to avoid executing empty script. + +##### Version 1.1 (Jun 2, 2010) + +- Removed isEmpty() for 1.5 comp; better input areas + +##### Version 1.0 (Feb 24, 2010) + +- Initial release. diff --git a/README.md b/README.md index eb384ff..9d7a5e0 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,29 @@ ## About This is a Jenkins plugin that allows for you to run operations with SSH. (I.e. commands, file management etc) +This plugin was derived from the very cool [SCP Plugin](https://plugins.jenkins.io/scp/). ## Usage Documentation and Examples -More documentation available on the Jenkins wiki: +First go to the global configuration page and add a SSH site. -https://wiki.jenkins-ci.org/display/JENKINS/SSH+Plugin +![](docs/images/ssh-global-cfg.png) + +For your job select a configured site and enter the shell commands that should be executed before and after the build. + +![](docs/images/ssh-job-cfg.png) + +Log will look like this. + +![](docs/images/ssh-job-log.png) + +## TODO + +- i18n +- we also need a post deploy script (ask some of the core team how to do that) +- investigate stop behavior of Hudson jobs using the ssh Plugin +- use same sites as scp plugin (plugin dependencies???) +- ... ## Building this project diff --git a/docs/images/ssh-global-cfg.png b/docs/images/ssh-global-cfg.png new file mode 100644 index 0000000..08e27b9 Binary files /dev/null and b/docs/images/ssh-global-cfg.png differ diff --git a/docs/images/ssh-job-cfg.png b/docs/images/ssh-job-cfg.png new file mode 100644 index 0000000..81758d0 Binary files /dev/null and b/docs/images/ssh-job-cfg.png differ diff --git a/docs/images/ssh-job-log.png b/docs/images/ssh-job-log.png new file mode 100644 index 0000000..1709cdf Binary files /dev/null and b/docs/images/ssh-job-log.png differ diff --git a/pom.xml b/pom.xml index 93cdef0..0d170e7 100644 --- a/pom.xml +++ b/pom.xml @@ -13,7 +13,7 @@ hpi Jenkins SSH plugin Execute shell scripts on remote host using ssh (pre and post build). Based on the cool scp plugin. - http://wiki.jenkins-ci.org/display/JENKINS/SSH+plugin + https://github.com/jenkinsci/${project.artifactId}-plugin