Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

migrate wiki documentation to github #20

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 102 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
### Changelog

##### Version 2.6.1 (April 13 2018)

- [JENKINS-19973](https://issues.jenkins.io/browse/JENKINS-19973) Option to hide ssh command in log

##### Version 2.6 (April 7 2018)

- [JENKINS-46172](https://issues.jenkins.io/browse/JENKINS-46172) Handle NPE when not all fields are specified &
save only properly configured sites

- [JENKINS-10128](https://issues.jenkins.io/browse/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 **does not work** in recent
Jenkins 2.x versions.

##### Version 2.5 (July 8 2017)

- [JENKINS-21436](https://issues.jenkins.io/browse/JENKINS-21436) Integrate with the SSH Credentials Plugin;
previous credentials are migrated

- [JENKINS-23231](https://issues.jenkins.io/browse/JENKINS-23231) Add timeout parameter

- [JENKINS-24913](https://issues.jenkins.io/browse/JENKINS-24913) Don't show sensitive build variables in console
log

- [JENKINS-12191](https://issues.jenkins.io/browse/JENKINS-12191) Restore resolving hostname from environment
variables

- [JENKINS-12191](https://issues.jenkins.io/browse/JENKINS-12191) Support build variables (substitution variables)
during command execution (env variables are exported before the
script)

- [JENKINS-24402](https://issues.jenkins.io/browse/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 **backup 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.io/browse/JENKINS-15265)

##### Version 2.2 (Sep 03 2012)

- fixed [JENKINS-15005](https://issues.jenkins.io/browse/JENKINS-15005)
and
[JENKINS-14420](https://issues.jenkins.io/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.io/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.
44 changes: 38 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,46 @@
ssh-plugin
===========
# ssh-plugin

This Plugin was derived from the very cool [SCP Plugin](https://plugins.jenkins.io/scp/).
You can use the SSH Plugin to run shell commands on a remote machine via ssh.

More documentation available on the Jenkins wiki:
You can use the SSH Plugin to run shell commands on a remote machine via ssh.

------------------------------------------------------------------------

### Usage

First go to the global configuration page and add a SSH site.

![ssh global config](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.

![ssh job config](docs/images/ssh-job-cfg.png)

https://wiki.jenkins-ci.org/display/JENKINS/SSH+Plugin
Log will look like this.

Contribute
------------
![ssh job log](docs/images/ssh-job-log.png)

------------------------------------------------------------------------

### Contribute

Fork and send a pull request (or create an issue on GitHub or in JIRA)

##### 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???)
- ...

------------------------------------------------------------------------

### Changelog

For recent versions, see [GitHub Releases](https://github.com/jenkinsci/ssh-plugin/releases)

For versions 2.6.1 and older, see [CHANGELOG.md](CHANGELOG.md)
Binary file added docs/images/ssh-global-cfg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ssh-job-cfg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/ssh-job-log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Based on the cool scp plugin.</description>
<name>Jenkins SSH plugin</name>
<version>2.7-SNAPSHOT</version>
<packaging>hpi</packaging>
<url>http://wiki.jenkins-ci.org/display/JENKINS/SSH+plugin</url>
<url>https://github.com/jenkinsci/ssh-plugin</url>

<developers>
<developer>
Expand Down Expand Up @@ -69,7 +69,7 @@ Based on the cool scp plugin.</description>
</snapshotRepository>
</distributionManagement>

<!-- get every artifact through maven.glassfish.org, which proxies all the
<!-- get every artifact through maven.glassfish.org, which proxies all the
artifacts that we need -->
<repositories>
<repository>
Expand Down