Merge pull request #41 from jglick/docs

Moved documentation from wiki

Jenkinsfile

@@ -1 +1 @@
-buildPlugin(configurations: buildPlugin.recommendedConfigurations())
+buildPlugin()

README.md

@@ -1,33 +1,53 @@
-Jenkins Ant Plugin
-=========================
+# Description
 
-This plugin permits Jenkins to run Apache Ant build steps.
+This plugin adds [Apache Ant](http://ant.apache.org/) support to Jenkins
 
-See [Ant Plugin](https://wiki.jenkins-ci.org/display/JENKINS/Ant+Plugin) for more information.
+This functionality used to be a part of the core, but as of Jenkins 1.431, it was split off into a separate plugin.
 
-[![Build Status](https://jenkins.ci.cloudbees.com/buildStatus/icon?job=plugins/ant-plugin)](https://jenkins.ci.cloudbees.com/job/plugins/job/ant-plugin/)
+# Installation and usage
 
-License
--------
+## Installation
 
-	The MIT License (MIT)
+For this plugin to be used, an Ant installation must be specified in the
+global Jenkins configuration. It can be installed automatically:
 
-    Copyright (c) 2014 <copyright holders>
+![](docs/images/automatic.png)
 
-    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:
+Or manually:
 
-    The above copyright notice and this permission notice shall be included in
-    all copies or substantial portions of the Software.
+![](docs/images/manual.png)
 
-    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.
+## Usage
+
+![](docs/images/usage.png)
+
+-   **Ant Version:** Ant Installation to use. See previous section.
+-   **Targets:** Ant targets to invoke. If left blank, default target will be invoked.
+-   **Build File:** Build file to use. If left blank, plugin will look for `build.xml` in the root directory.
+-   **Properties:** Additional parameters (typical properties file format) to pass to the build. They are passed like `-Dname=value`
+-   **Java Options:** Custom `ANT_OPTS`.
+
+
+An example of using the Ant task inside Pipeline DSL.
+This code snippet must be put inside a `step` block when using the declarative syntax.
+
+```groovy
+withAnt(installation: 'myinstall') {
+    dir("scoring") {
+    if (isUnix()) {
+      sh "ant mytarget"
+    } else {
+      bat "ant mytarget"
+    }
+}
+```
+
+# Changelog
+
+## Version 1.10 and later
+
+See [GitHub releases](https://github.com/jenkinsci/ant-plugin/releases).
+
+## Version 1.9 and older
+
+See the [old changelog](docs/old-changelog.md).

docs/old-changelog.md

@@ -0,0 +1,64 @@
+# Version 1.10 and later
+
+See [GitHub releases](https://github.com/jenkinsci/ant-plugin/releases).
+
+# Version 1.9 (2018-10-29)
+
+-   [JENKINS-54133](https://issues.jenkins-ci.org/browse/JENKINS-54133) (as applied to Ant console notes)
+-   [JENKINS-52139](https://issues.jenkins-ci.org/browse/JENKINS-52139)
+
+# Version 1.8 (Jan 22, 2018)
+
+-   [Fix security
+    issue](https://jenkins.io/security/advisory/2018-01-22/)
+
+# Version 1.7 (Aug 21, 2017)
+
+-    Bump baseline to 1.651.3 and fix
+    tests \[[JENKINS-46317](https://issues.jenkins-ci.org/browse/JENKINS-46317)\]
+
+# Version 1.6 (Aug 08, 2017)
+
+Now requires Jenkins 1.642.x or newer.
+
+-   Pipeline-compatible build
+    wrapper \[[JENKINS-26056](https://issues.jenkins-ci.org/browse/JENKINS-26056)\]
+
+# Version 1.5 (May 9, 2017)
+
+-   Add description to
+    POM \[[JENKINS-40002](https://issues.jenkins-ci.org/browse/JENKINS-40002)\]
+-   Ant plugin does not correctly resolve and property resolving empty
+    build
+    parameter \[[JENKINS-41801](https://issues.jenkins-ci.org/browse/JENKINS-41801)\]
+-   AntInstallation not setting
+    PATH+ANT \[[JENKINS-42382](https://issues.jenkins-ci.org/browse/JENKINS-42382)\]
+-   Improve test coverage
+
+# Version 1.4 (Aug 30, 2016)
+
+-   Descriptors annotated with @Symbol
+    \[[JENKINS-37388](https://issues.jenkins-ci.org/browse/JENKINS-37388)\]
+-   Update test dependencies.
+
+# Version 1.3 (May 11, 2016)
+
+-   Upgrade to new [plugin parent
+    pom](https://github.com/jenkinsci/plugin-pom).
+-   Fixed regression: empty parameters causing the build to fail
+    \[[JENKINS-33712](https://issues.jenkins-ci.org/browse/JENKINS-33712)\]
+-   Update French translations
+
+# Version 1.2 (Feb 20, 2013)
+
+-   Mmproved documentation
+-   Translations
+-   Label in Plugin Manager
+
+# Version 1.1 (Sep 19, 2011)
+
+-   First release, split off from the core.
+
+# Version 1.0 (Sep 19, 2011)
+
+-   Erroneous release. Initial release is 1.1

pom.xml

@@ -11,8 +11,7 @@
   <version>${revision}${changelist}</version>
   <packaging>hpi</packaging>
   <name>Ant Plugin</name>
-  <description>Adds Apache Ant support to Jenkins</description>
-  <url>https://wiki.jenkins-ci.org/display/JENKINS/Ant+Plugin</url>
+  <url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
 
   <developers>
     <developer>

src/main/resources/index.jelly

@@ -0,0 +1,4 @@
+<?jelly escape-by-default='true'?>
+<div>
+    Adds Apache Ant support to Jenkins
+</div>