Merge pull request #17 from ikedam/feature/moveDocToGithub

Move documentations to github

CHANGELOG.adoc

@@ -0,0 +1,78 @@
+== Change Log
+
+=== 1.4.0
+
+Release date: Jul 24, 2016
+
+* Targets Jenkins 1.532. (was 1.480.3 till 1.3.0)
+* Improved permission checks
+(https://issues.jenkins-ci.org/browse/JENKINS-36672[JENKINS-36672])
+** Jobcopy build step is authorized as anonymous when the build is run
+as SYSTEM (that is, if not authorization for the job is not configured)
+** Requires EXTENTED_READ (or CONFIGURE) permission to read job
+configurations.
+** See
+https://wiki.jenkins.io/display/JENKINS/Jobcopy+Builder+plugin#JobcopyBuilderplugin-Permissionstocopyjobs[#Permissions
+to copy jobs] for details.
+
+=== 1.3.0
+
+Release date: May 24, 2015
+
+* Added "Disable Job" operation
+(https://issues.jenkins-ci.org/browse/JENKINS-28439[JENKINS-28439])
+
+=== 1.2.0
+
+Release date: Sep 11, 2014)
+
+* Changed target Jenkins version from 1.466 to 1.480.3.
+* Supports
+https://wiki.jenkins.io/display/JENKINS/CloudBees+Folders+Plugin[CloudBees
+Folders Plugin]
+(https://issues.jenkins-ci.org/browse/JENKINS-24515[JENKINS-24515])
+** You can copy a job in a folder into another folder.
+** You can copy folders.
+
+=== 1.1.2
+
+Release date: Dec 22, 2013)
+
+* FIXED: Build results page shows wrong link for Copied To and Copied
+From (https://issues.jenkins-ci.org/browse/JENKINS-21080[JENKINS-21080])
+
+=== 1.1.1
+
+Release date: Aug 31, 2013
+
+* Fixed a problem with overwriting multi-configuration projects.
+** combination filter was not removed even when it is removed in the
+source project.
+
+=== 1.1.0
+
+Release date: Feb 27, 2013
+
+* Added advanced configuration to copy additional files.
+** Useful for plugins that does not store configurations in config.xml
+of the job.
+** For example, you can copy configurations of
+https://wiki.jenkins.io/display/JENKINS/Promoted+Builds+Plugin[Promoted
+Builds Plugin].
+
+=== 1.0.1
+
+Release date: Feb 06, 2013
+
+* Improved overwrite behavior
+** Version 1.0.0: delete the old job, and create a new job. Also builds
+are deleted.
+** Version 1.0.1 and later: update the configuration. Builds are
+preserved.
+* expand "From Job Name" field
+
+=== 1.0.0
+
+Release date: Jan 14, 2013
+
+* Initial release.

README.adoc

@@ -0,0 +1,139 @@
+= Jobcopy Builder plugin
+
+:sectanchors:
+
+This plugin adds "Copy Job" as a build step.You can select how to
+retrieve choices, including the way to share choices among all jobs.
+
+:toc:
+
+[[JobcopyBuilderplugin-Whatsthis]]
+== What's this?
+
+This plugin provides a Copy Job build step:
+
+* It makes a new job from an existing job.
+** You can copy multiple jobs in one build execution with specifying
+multiple Copy Job build steps.
+** Can be applied to any type of jobs.
+* You specify following parameters.
+** From Job Name
+*** Variable expressions can be used.
+** To Job Name
+*** Variable expressions can be used.
+** Overwrite
+*** Specifies whether to overwrite the destination job if it already
+exists.
+* Additional operations can be performed when copying.
+** Enable Job: Enabling the destination job if the source job is
+disabled.
+** Disable Job: Disabling the destination job if the source job is
+enabled. ( >= 1.3.0)
+** Replace String: Replace strings in a job configuration.
+*** Source and destination strings can contain variable expressions.
+* Additional operation can be extended by using Extension Points.
+
+[[JobcopyBuilderplugin-Screenshots]]
+== Screenshots
+
+. You can add "Copy Job" build step. +
+#image:docs/images/01-configure.png[image]#
+. "Copy Job" performs additional operations. Replacing strings in the
+configuration, enabling a disabled job.
+* The job copied from +
+#image:docs/images/02-copyfrom01.png[image]#
+* The job copied to. String "VERSION" is replaced, and the job is
+enabled. +
+#image:docs/images/03-copyto01.png[image]#
+. Replacing strings can be applied to any part of configurations,
+including that of plugins. This is a example that the branch field of
+Git plugin is replaced.
+* The job copied from. +
+#image:docs/images/04-copyfrom02.png[image]#
+* The job copied to. String "VERSION" is replaced. +
+#image:docs/images/05-copyto02.png[image]#
+
+[[JobcopyBuilderplugin-Howdoesthiswork]]
+== How does this work?
+
+This plugin works as following:
+
+. Reads the configuration xml (config.xml) of the copying job.
+. Applies the operations to the configuration xml string.
+. Create a new job with the processed configuration xml string.
+
+[[JobcopyBuilderplugin-Extensionpoint]]
+== Extension point
+
+A new way to provide choices can be added with implementing
+`+JobcopyOperation+`, overriding the following method:
+
+[source,java]
+----
+public String perform(String xmlString, String encoding, EnvVars env, PrintStream logger);
+----
+
+or, with extending `+AbstractXmlJobcopyOperation+`, overriding the
+following method:
+
+[source,java]
+----
+abstract public Document perform(Document doc, EnvVars env, PrintStream logger);
+----
+
+[[JobcopyBuilderplugin-Usedwithpromotedbuilds]]
+== Used with promoted builds
+
+When used with
+https://plugins.jenkins.io/promoted-builds/[Promoted
+Builds Plugin], the configurations of promotions are not copied for they
+are not stored in config.xml. +
+Do as followings:
+
+* Click "Advanced" in "copy Job"
+* Add "Additional File Sets", specify "promotions/*/config.xml" in
+"Files".
+
+[[JobcopyBuilderplugin-Permissionstocopyjobs]]
+== Permissions to copy jobs
+
+* "Copy Job" build step requires following permissions.
++
+[cols=",,",options="header",]
+|===
+|Target Job |Required permissions |Notes
+|Item to copy from |Job/Read, Job/ExtendedRead |Job/ExtendedRead is
+displayed only when you install
+https://plugins.jenkins.io/extended-read-permission/[Extended
+Read Permission Plugin]. You can grant it by granting Job/Configure
+instead.
+
+|Item to copy to (when create) |Job/Create | 
+
+|Item to copy to (when overwrite) |Job/Read, Job/Configure | 
+|===
+* "Copy Job" defaults to run as ANONYMOUS.
+** If you want "Copy Job" run as a specific user, use other plugins
+authenticate builds. e.g.
+https://plugins.jenkins.io/authorize-project/[Authorize
+Project plugin]
+
+[[JobcopyBuilderplugin-Issues]]
+== Issues
+
+To report a bug or request an enhancement to this plugin please create a
+ticket in JIRA (you need to login or to sign up for an account). Also
+have a look on
+https://www.jenkins.io/participate/report-issue/[How to
+report an issue]
+
+* https://issues.jenkins-ci.org/issues/?jql=resolution%20%3D%20Unresolved%20AND%20component%20%3D%20jobcopy-builder-plugin[Open
+Issues]
+* https://issues.jenkins-ci.org/secure/CreateIssueDetails!init.jspa?pid=10172&issuetype=1&components=17506&priority=4&assignee=ikedam[Bug
+report]
+* https://issues.jenkins-ci.org/secure/CreateIssueDetails!init.jspa?pid=10172&issuetype=4&components=17506&priority=4[Request
+or propose an improvement of existing feature]
+* https://issues.jenkins-ci.org/secure/CreateIssueDetails!init.jspa?pid=10172&issuetype=2&components=17506&priority=4[Request
+or propose a new feature]
+
+include::CHANGELOG.adoc[]

pom.xml

@@ -13,7 +13,7 @@
   <name>Jobcopy Builder plugin</name>
   <description>Jenkins plugin to copy a job in a build step.</description>
 
-  <url>http://wiki.jenkins-ci.org/display/JENKINS/Jobcopy+Builder+plugin</url>
+  <url>https://github.com/jenkinsci/${project.artifactId}-plugin</url>
 
   <scm>
     <connection>scm:git:git://github.com/jenkinsci/${project.artifactId}-plugin.git</connection>