Merge pull request #34 from jglick/release-drafter

[INFRA-2412] Prepare for Release Drafter & migrate from wiki

Author: jglick

.github/release-drafter.yml

@@ -0,0 +1,2 @@
+_extends: .github
+tag-template: ssh-agent-$NEXT_MINOR_VERSION

README.md

@@ -1,60 +1,99 @@
-Jenkins SSH Agent Plugin
-========================
+# SSH Agent Plugin
 
-Read more: [http://wiki.jenkins-ci.org/display/JENKINS/SSH+Agent+Plugin](http://wiki.jenkins-ci.org/display/JENKINS/SSH+Agent+Plugin)
+This plugin allows you to provide SSH credentials to builds via a
+ssh-agent in Jenkins.
 
-Development
-===========
+# Requirements
 
-Start the local Jenkins instance:
+Currently all **Windows** nodes (including the master) on which this
+plugin will be used must have the [Apache Tomcat Native
+libraries](http://tomcat.apache.org/native-doc/)
+installed. As of 1.0 should be unnecessary for Unix nodes. As of 1.14
+unnecessary if `ssh-agent` is installed.
 
-    mvn hpi:run
+# Configuring
 
+First you need to add some SSH Credentials to your instance:
 
-How to install
---------------
+Jenkins \| Manage Jenkins \| Manage Credentials
 
-Run
+![](docs/images/Screen_Shot_2012-10-26_at_12.25.04.png)
 
-	mvn clean package
+Note that only Private Key based credentials can be used.
 
-to create the plugin .hpi file.
+Then configure your build to use the credentials:
 
+![](docs/images/Screen_Shot_2012-10-26_at_12.26.13.png)
 
-To install:
+And then your build will have those credentials available, e.g.
 
-1. copy the resulting ./target/ssh-agent.hpi file to the $JENKINS_HOME/plugins directory. Don't forget to restart Jenkins afterwards.
+![](docs/images/Screen_Shot_2012-10-26_at_11.54.21.png)
 
-2. or use the plugin management console (http://example.com:8080/pluginManager/advanced) to upload the hpi file. You have to restart Jenkins in order to find the pluing in the installed plugins list.
+From a Pipeline job, use the `sshagent` step.
 
+# Installation Example: MacOSX (10.7.5)
 
-Plugin releases
----------------
+**Irrelevant in 1.14+ when `ssh-agent` is available in the path.**
 
-	mvn release:prepare release:perform -B
+Prerequisites:
 
+-   JDK7. The tomcat native libraries target the java 7 version.
+-   APR - this seems to be preinstalled in /usr/lib/apr.
 
-License
--------
+Note that tomcat itself is not needed. This works fine with winstone
+(just running jenkins jar from command line).
 
-	(The MIT License)
+Download and extract the tomcat native
+library: <http://tomcat.apache.org/download-native.cgi>
 
-    Copyright © 2012, CloudBees, Inc., Stephen Connolly.
+    tar -zxvf tomcat-native-1.1.XX-src.tar.gz
 
-    Permission is hereby granted, free of charge, to any person obtaining a copy
-    of this software and associated documentation files (the "Software"), to deal
-    in the Software without restriction, including without limitation the rights
-    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-    copies of the Software, and to permit persons to whom the Software is
-    furnished to do so, subject to the following conditions:
+Build the native library:
 
-    The above copyright notice and this permission notice shall be included in
-    all copies or substantial portions of the Software.
+    cd tomcat-native-1.1.XX/jni/native
 
-    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-    THE SOFTWARE.
+    ./configure --with-apr=/usr/bin/apr-1-config
+
+    make && sudo make install
+
+Build the java interface:
+
+    cd ..
+    export JAVA_HOME=/Library/Java/JavaVirtualMachines/jdk1.7.0_17.jdk/Contents/Home
+
+    ant build
+
+    ant jar
+
+Copy the output jar somewhere suitable for inclusion in your jenkins
+CLASSPATH.
+
+Set environment variables prior to starting jenkins:
+
+    export DYLD_LIBRARY_PATH=/usr/local/apr/lib
+    export CLASSPATH=/path/to/tomcat-native-1.1.XX.jar
+    java -jar jenkins.war
+
+Additionally, you might have to add bouncycastle to your JCE providers.
+If you attempt to use the plugin and get an exception like the
+following:
+
+    java.lang.IllegalStateException: BouncyCastle must be registered as a JCE provider
+
+Then you may need to configure the jce provider. One way is to do this
+right in the JRE, so if Jenkins is using the same jdk as above, edit
+
+/Library/Java/JavaVirtualMachines/jdk1.7.0\_17.jdk/Contents/Home/jre/lib/security/java.security,
+and add the following line:
+
+    security.provider.11=org.bouncycastle.jce.provider.BouncyCastleProvider
+
+Then, restart jenkins.
+
+From there, configure using the instructions above.
+
+# Version History
+
+For new versions, see [GitHub releases](https://github.com/jenkinsci/ssh-agent-plugin/releases).
+
+For old versions, see the [old changelog](docs/old-changelog.md).

docs/images/Screen_Shot_2012-10-26_at_11.54.21.png

@@ -0,0 +1,136 @@
+For new versions, see [GitHub releases](https://github.com/jenkinsci/ssh-agent-plugin/releases).
+
+### Version 1.17 (2018-10-02)
+
+-   Did not properly interact with `withDockerContainer` when run on a
+    machine with `DISPLAY=:0` set.
+
+### Version 1.16 (2018-07-30)
+
+-   [Fix security
+    issue](https://jenkins.io/security/advisory/2018-07-30/#SECURITY-704)
+
+### Version 1.15 (2017-04-06)
+
+-   [issue@42093](#) Fixed quoting for askpass in
+    command-line implementation. 
+
+### Version 1.14 (2017-02-10)
+
+-   [JENKINS-36997](https://issues.jenkins-ci.org/browse/JENKINS-36997)
+    New default implementation that uses command-line `ssh-agent`.
+    Should fix various problems with crypto APIs,
+    `docker.image(…).inside {sshagent(…) {…}}`, etc.
+-   [JENKINS-38830](https://issues.jenkins-ci.org/browse/JENKINS-38830)
+    Track credentials used in the wrapper.
+-   [JENKINS-35563](https://issues.jenkins-ci.org/browse/JENKINS-35563)
+    Fixes to credentials dropdown.
+
+### Version 1.13 (2016-03-03)
+
+-   [JENKINS-32120](https://issues.jenkins-ci.org/browse/JENKINS-32120)
+    Register Bouncy Castle on the remote agent by using Bouncy Castle
+    API plugin
+
+Apparently does not work in some versions of Jenkins; see
+[JENKINS-36935](https://issues.jenkins-ci.org/browse/JENKINS-36935).
+
+### Version 1.12 (2016-03-03)
+
+-   **Wrong release**. Release process broken due a network issue.
+
+### Version 1.11 (2016-03-03)
+
+-   [JENKINS-35463](https://issues.jenkins-ci.org/browse/JENKINS-35463)
+    First release using
+    [bouncycastle-api-plugin](https://wiki.jenkins-ci.org/display/JENKINS/Bouncy+Castle+API+Plugin)
+
+### Version 1.10 (2016-03-03)
+
+-   [JENKINS-27152](https://issues.jenkins-ci.org/browse/JENKINS-27152) / [JENKINS-32624](https://issues.jenkins-ci.org/browse/JENKINS-32624)
+    Use a standardized temporary directory compatible with Docker
+    Pipeline.
+
+### Version 1.9 (2015-12-07)
+
+Changelog unrecorded.
+
+### Version 1.8 (2015-08-07)
+
+-   Compatible with
+    [Workflow](https://wiki.jenkins-ci.org/display/JENKINS/Workflow+Plugin) (issue
+    [\#28689](https://issues.jenkins-ci.org/browse/JENKINS-28689))
+
+### Version 1.7 (2015-06-02)
+
+-   Fixed a socket and thread leak ([issue
+    \#27555](https://issues.jenkins-ci.org/browse/JENKINS-27555))
+
+### Version 1.6 (2015-04-20)
+
+-   SSH agent socket service thread shouldn't keep JVM alive.
+
+### Version 1.5 (2014-08-11)
+
+-   Add support for multiple credentials
+-   Add support for parameterized credentials
+
+### Version 1.4.2 (2014-08-11)
+
+-   Fix for
+    [JENKINS-20276](https://issues.jenkins-ci.org/browse/JENKINS-20276)
+-   **WARNING: Due to classpath conflicts, this plugin will not work if
+    1.518 \<= Jenkins Version \< 1.533 (i.e. 1.518 broke it, 1.533 fixed
+    it)**
+
+### Version 1.4.1 (2013-11-08)
+
+-   Switch from f:select to c:select so that in-place addition of
+    credentials is supported when the credentials plugin exposes such
+    support
+-   **WARNING: Due to classpath conflicts, this plugin will not work if
+    1.518 \<= Jenkins Version \< 1.533 (i.e. 1.518 broke it, 1.533 fixed
+    it)**
+
+### Version 1.4 (2013-10-08)
+
+-   Minor improvement in exception handling
+-   Minor improvement in fault reporting
+-   Update JNR libraries
+-   **WARNING: Due to classpath conflicts, this plugin will not work if
+    1.518 \<= Jenkins Version \< 1.533 (i.e. 1.518 broke it, 1.533 fixed
+    it)**
+
+### Version 1.3 (2013-08-09)
+
+-   Set-up SSH Agent before SCM checkout, this way [GIT can use the ssh
+    agent](https://issues.jenkins-ci.org/browse/JENKINS-12492).
+    (Contributed by Patric Boos)
+-   Upgrade to [SSH Credentials
+    1.3](https://wiki.jenkins.io/display/JENKINS/SSH+Credentials+Plugin)
+
+### Version 1.2 (2013-08-07)
+
+-   Upgrade to [Credentials plugin
+    1.6](https://wiki.jenkins.io/display/JENKINS/Credentials+Plugin) and
+    [SSH Credentials plugin
+    1.0](https://wiki.jenkins.io/display/JENKINS/SSH+Credentials+Plugin).
+    This now allows serving multiple private keys from the users home
+    directory, e.g. \~/.ssh/id\_rsa, \~/.ssh/id\_dsa and
+    \~/.ssh/identity
+
+### Version 1.1 (2013-07-04)
+
+-   If BouncyCastleProvider is not registered, try to register it
+    ourselves anyway... this should make installation and configuration
+    even easier.
+
+### Version 1.0 (2012-11-01)
+
+-   Using jnr-unixsocket have been able to remove the requirement on
+    Apache Tomcat Native for unix nodes. Likely still require the Apache
+    Tomcat Native for Windows nodes.
+
+### Version 0.1 (2012-10-26)
+
+-   Initial release 

docs/images/Screen_Shot_2012-10-26_at_12.25.04.png

@@ -39,7 +39,7 @@
 
   <name>SSH Agent Plugin</name>
   <description>This plugin allows you to provide SSH credentials to builds via a ssh-agent in Jenkins</description>
-  <url>http://wiki.jenkins-ci.org/display/JENKINS/SSH+Agent+Plugin</url>
+  <url>https://github.com/jenkinsci/ssh-agent-plugin</url>
   <licenses>
     <license>
       <name>The MIT license</name>