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

Merged
merged 1 commit into from
Nov 11, 2020
Merged
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
103 changes: 103 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
[[ConditionalBuildStepPlugin-VersionHistory]]
== Version History

[[ConditionalBuildStepPlugin-1.3.6(9.June2017)]]
=== 1.3.6 (9. June 2017)

* integrate https://issues.jenkins-ci.org/browse/JENKINS-43887[JENKINS-43887]
upgrade parent pom to 2.x (thanks varyvol
https://github.com/jenkinsci/conditional-buildstep-plugin/pull/14[#14])
* ConditionalBuilder now implements DependencyDeclarer (thanks
TWestling https://github.com/jenkinsci/conditional-buildstep-plugin/pull/12[#12])

[[ConditionalBuildStepPlugin-1.3.5(16.June2016)]]
=== 1.3.5 (16. June 2016)

* fix
https://issues.jenkins-ci.org/browse/JENKINS-35526[JENKINS-35526], update
to DependencyDeclarer
(https://github.com/jenkinsci/conditional-buildstep-plugin/pull/10[PR#10]
thanks fbelzunc)
* fix
https://issues.jenkins-ci.org/browse/JENKINS-34971[JENKINS-34971] describe
advanced options about failing the evaluation of a condition

[[ConditionalBuildStepPlugin-1.3.3(13.Nov.2013)]]
=== 1.3.3 (13. Nov. 2013)

* fix https://issues.jenkins-ci.org/browse/JENKINS-20543[JENKINS-20543]
fix "NoSuchMethodError:
org.jenkinsci.plugins.conditionalbuildstep.ConditionalBuildStepHelper.getContainedBuilders()"

[[ConditionalBuildStepPlugin-1.3.2(10.Nov.2013)]]
=== 1.3.2 (10. Nov.2013)

* add helper (ConditionalBuildStepHelper) to support working with
wrapped build steps to support
https://issues.jenkins-ci.org/browse/JENKINS-18967[JENKINS-18967]
* enhance ConditionalBuildStepHelper to also return pre- and post
builders from a maven project

[[ConditionalBuildStepPlugin-1.3(16.July2013)]]
=== 1.3 (16. July 2013)

* fix https://issues.jenkins-ci.org/browse/JENKINS-18135[JENKINS-18135]
fix compatibility issues
with https://wiki.jenkins-ci.org/display/JENKINS/Any+Build+Step+Plugin[Any
Build Step Plugin]
* lift dependency to core LTS 1.480.3

[[ConditionalBuildStepPlugin-1.2.2(2.June2013)]]
=== 1.2.2 (2. June 2013)

* fix https://issues.jenkins-ci.org/browse/JENKINS-17836[JENKINS-17836]
exception if there is no builder defined within the conditional build
step

[[ConditionalBuildStepPlugin-1.2.1(1.Nov2012)]]
=== 1.2.1 (1. Nov 2012)

* Fix https://issues.jenkins-ci.org/browse/JENKINS-13871[JENKINS-13871]
Using "Conditional build step" and "Parameterized build step" in same
step is preventing parallel executions of same job

[[ConditionalBuildStepPlugin-1.2(11.Okt2012)]]
=== 1.2 (11. Okt 2012)

* Fix https://issues.jenkins-ci.org/browse/JENKINS-14118[JENKINS-14118]
show builds triggered through "Conditional buildstep" plugin reported as
downstream builds for the current build.

[[ConditionalBuildStepPlugin-1.1(6.May2012)]]
=== 1.1 (6. May 2012)

* Fix https://issues.jenkins-ci.org/browse/JENKINS-13618[JENKINS-13618]
Unable to use multiple Conditional Steps in the Prebuild section of
Multi configuration job

[[ConditionalBuildStepPlugin-1.0(31.March2012)]]
=== 1.0 (31. March 2012)

* Fix https://issues.jenkins-ci.org/browse/JENKINS-13112[JENKINS-13112]
- Adding any post-build step as a build step causes exception (caused in
combination with the
https://wiki.jenkins-ci.org/display/JENKINS/Any+Build+Step+Plugin[Any
Build Step Plugin])

[[ConditionalBuildStepPlugin-0.0.3(31.Dec.2011)]]
=== 0.0.3 (31. Dec. 2011)

* Fix https://issues.jenkins-ci.org/browse/JENKINS-12036[JENKINS-12036]
- conditional buildsteps does not support matrix build

[[ConditionalBuildStepPlugin-0.0.2(14.Nov.2011)]]
=== 0.0.2 (14. Nov. 2011)

* integrate https://wiki.jenkins-ci.org/display/JENKINS/Run+Condition+Plugin[Run
Condition Plugin]  to ease condition extensions, which also fixes
https://issues.jenkins-ci.org/browse/JENKINS-11671[JENKINS-11671]

[[ConditionalBuildStepPlugin-0.0.1]]
=== 0.0.1

* initial
81 changes: 81 additions & 0 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
= Conditional BuildStep Plugin for Jenkins

A buildstep wrapping any number of other buildsteps, controlling their
execution based on a defined condition.

[[ConditionalBuildStepPlugin-Info]]
== Info

This plugin requires the
https://plugins.jenkins.io/token-macro/[TokenMacro Plugin] and the 
https://plugins.jenkins.io/run-condition/[Run Condition Plugin] to be installed!

* Ever wanted to have more control whether a step should be executed or
not?
* Want to reduce the number of jobs doing nearly the same thing?

Add a conditional buildstep which acts as a container. It will allow you
to define a condition controling the execution of the step(s).

[[ConditionalBuildStepPlugin-Conditions]]
== Conditions

There are multiple conditions one can choose of, these are all defined
by the
https://plugins.jenkins.io/run-condition/[Run
Condition Plugin]

Missing builder

If you're not able to add the builder of your choice within a
conditional build step (because it's not available within the dropdown),
then this is likely because the builder does not provide a
_@DataBoundConstructor_ constructor and/or the Descriptor does not
extend _hudson.tasks.BuildStepDescriptor_. For non programmers: the
plugin you would like to use does not yet follow the newest Jenkins
coding guidelines. Without this, the conditional buildstep plugin is not
able to work with it.

[[ConditionalBuildStepPlugin-Conditionalstep(single)]]
== Conditional step (single)

This build step allows you to select any build step and define a
condition to control whether the step should be executed. +
For reasons why you might want to use this step, see
https://wiki.jenkins-ci.org/pages/viewpage.action?pageId=59507542[Why
use Conditional step (single)?]

[.confluence-embedded-file-wrapper]#image:docs/images/screen-capture-1.jpg[image]#

[[ConditionalBuildStepPlugin-Conditionalsteps(multiple)]]
== Conditional steps (multiple)

A 'Conditional steps (multiple)' container is able to contain any number
of any other buildsteps (e.g. Shell, Ant, Maven,...) and you can have
any number of 'Conditional Steps' containers, each configured with a
different condition.

[.confluence-embedded-file-wrapper]#image:docs/images/screen-capture-2.jpg[image]#

[[ConditionalBuildStepPlugin-Examples]]
== Examples

Please check out the examples at the
https://plugins.jenkins.io/run-condition/[Run
Condition Plugin]

[[ConditionalBuildStepPlugin-Changelog]]
== Changelog
For recent versions, see https://github.com/jenkinsci/conditional-buildstep-plugin/releases[GitHub Releases]

For versions 1.3.6 and older, see CHANGELOG.adoc


[[ConditionalBuildStepPlugin-HelpandSupport]]
== Help and Support

For Help and support please use the
http://jenkins-ci.org/content/mailing-lists[Jenkins Users] mailing list
or the Issue tracker (JIRA).

Licensed under [MIT Licence].
18 changes: 0 additions & 18 deletions README.md

This file was deleted.

Binary file added docs/images/screen-capture-1.jpg
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/screen-capture-2.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 3 additions & 5 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

<name>Conditional BuildStep</name>
<description>A buildstep wrapping any number of other buildsteps, controlling their execution based on a defined condition.</description>
<url>https://wiki.jenkins-ci.org/display/JENKINS/Conditional+BuildStep+Plugin</url>
<url>https://plugins.jenkins.io/conditional-buildstep/</url>
<scm>
<connection>scm:git:git://github.com/jenkinsci/conditional-buildstep-plugin.git</connection>
<developerConnection>scm:git:ssh://[email protected]/jenkinsci/conditional-buildstep-plugin.git</developerConnection>
Expand Down Expand Up @@ -111,7 +111,7 @@
<artifactId>maven-localizer-plugin</artifactId>
<version>1.14</version>
</plugin>
<!--This plugin's configuration is used to store Eclipse m2e settings
<!--This plugin's configuration is used to store Eclipse m2e settings
only. It has no influence on the Maven build itself. -->
<plugin>
<groupId>org.eclipse.m2e</groupId>
Expand Down Expand Up @@ -154,6 +154,4 @@
</plugins>
</pluginManagement>
</build>
</project>


</project>