Skip to content

Commit fb41e9f

Browse files
authored
Remove System V init instructions that no longer work (#383)
* Remove System V init instructions that no longer work Use consistent headings and improve the phrasing a little. * Use a more specific link * Move property earlier in the line * More phrasing fixes * Fix README spelling error * Fix changelog spelling errors * Fix online help spelling errors * Fix spelling error in form title
1 parent abd55a2 commit fb41e9f

File tree

5 files changed

+30
-55
lines changed

5 files changed

+30
-55
lines changed

CHANGELOG.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ Fixed Issues
198198

199199
- Parameterized trigger from a multi-configuration project triggers
200200
downstream jobs twice (JENKINS-11669)
201-
- Allow speciying Git SHA1 commit id for next build(s) as Predefined
201+
- Allow specifying Git SHA1 commit id for next build(s) as Predefined
202202
parameter (JENKINS-13852)
203203
- Counter/File Parameter Factories now can prevent triggering, skip
204204
adding parameteers or fail the build if errors occur.
@@ -254,7 +254,7 @@ Release date: (Feb 9, 2012)
254254
- When multiple builds are launched as blocking build steps, all
255255
should be listed as "waiting to complete", and should be listed in
256256
launched order. (JENKINS-11116, JENKINS-11117)
257-
- Fixed a compatibility with hierachical jobs (such as the CloudBees
257+
- Fixed a compatibility with hierarchical jobs (such as the CloudBees
258258
folder plugin.)
259259
- Added a mechanism to repeatedly invoke jobs for each file that
260260
matches GLOB ([pull
@@ -416,7 +416,7 @@ Release date: (Feb 28, 2009)
416416

417417
Release date: (Feb 27, 2009)
418418

419-
- Fixes incompatiblity with Jenkins 1.285. Jenkins 1.286 is a minimum
419+
- Fixes incompatibility with Jenkins 1.285. Jenkins 1.286 is a minimum
420420
requirement for this version.
421421

422422
#### 1.0, 1.1

README.md

+24-49
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
1-
Parameterized Trigger Plugin
2-
============================
1+
# Parameterized Trigger Plugin
32

43
[![Jenkins Plugin](https://img.shields.io/jenkins/plugin/v/parameterized-trigger.svg)](https://plugins.jenkins.io/parameterized-trigger)
54
[![GitHub release](https://img.shields.io/github/release/jenkinsci/parameterized-trigger-plugin.svg?label=changelog)](https://github.com/jenkinsci/parameterized-trigger-plugin/releases/latest)
@@ -11,7 +10,7 @@ with various ways of specifying parameters for the new build.
1110
These new builds appear as "Subprojects" in the Jenkins UI when you
1211
are looking at a project that triggers them.
1312

14-
You can add multiple configurations: each has a list of projects to trigger, a condition for when to trigger them
13+
You can add multiple configurations: each has a list of projects to trigger, a condition for when to trigger them
1514
(based on the result of the current build), and a parameters section.
1615

1716
There is also a Parameterized Remote Trigger Plugin in case you want to trigger a build on a different/remote Jenkins Controller.
@@ -35,7 +34,7 @@ This lets you create a "function call" like semantics.
3534

3635
#### Usage as a Build step
3736

38-
When using the _Trigger/Call builds on another project_ item.
37+
When using the _Trigger/Call builds on another project_ item.
3938
If the trigger is configured with the "Block until the triggered projects finish their builds" enabled, the following Environment variables are made available for further build steps.
4039

4140
Env variables for future build steps:
@@ -48,87 +47,63 @@ Env variables for future build steps:
4847
- `TRIGGERED_BUILD_RESULT_<project name>*RUN*<build number>` - Result of triggered build for build number
4948
- `TRIGGERED_BUILD_RUN_COUNT_<project name>` - Number of builds triggered for the project
5049

51-
From 2.17 onwards: All Project names have characters not a-zA-Z or 0-9 replaced by
52-
`_(multiple characters are condensed into a single)`.  
50+
From 2.17 onwards: All Project names have characters not a-zA-Z or 0-9 replaced by
51+
`_(multiple characters are condensed into a single)`.
5352

5453
Note that with the BuildStep a variable can be used for the project name, I.E. `${projectName}`.
5554

56-
#### Use of the plugin in a Matrix job
55+
## Use of the plugin in a Matrix job
5756

58-
##### Post build task
57+
### Post build task
5958

60-
When using the trigger parameterized build as a post build task for a matrix job the triggering will be be done once when all of the different matrix configurations have completed.
59+
When using the trigger parameterized build as a post build task for a matrix job the triggering will be be done once when all of the different matrix configurations have completed.
6160
In this case some of the Environment variables may not be resolvable as passing them to downstream jobs will fail.
6261
You also cannot use a variable for the downstream project name.
63-
If this functionality is needed, the BuildStep must be used. 
62+
If this functionality is needed, the BuildStep must be used.
6463

65-
Environment variables that should be available are the the default shell ones (`<yourserver:port>/env-vars.html`) and ones defined as Parameters.
64+
Environment variables that should be available are the the default shell ones (`<yourserver:port>/env-vars.html`) and ones defined as Parameters.
6665
Variables added by the other plugins as a buildwrappers may not be available.
6766

68-
##### Build step
67+
### Build step
6968

70-
When using the trigger parameterized build as a buildstep it will be called for every different configuration,
69+
When using the trigger parameterized build as a build step it will be called for every different configuration,
7170
so if triggering another project with no parameters it will be done the same number of times as you have configurations,
7271
possible causing the triggered job to run more than once.
7372

7473
However this also allows you to trigger other jobs with parameters relating to the current configuration,
7574
i.e. triggering a build on the same node with the same JDK.
7675

77-
#### Plugins contributing additional parameter types to this plugin
76+
## Plugins contributing additional parameter types to this plugin
7877

7978
* Git Plugin
8079
* NodeLabel Parameter Plugin
8180

82-
#### Backward compatibility with version 2.22
81+
## Backward compatibility with version 2.22
8382

8483
- Since Parameterized Trigger 2.23, there are cases that Parameterized Trigger fails to trigger downstream builds that can be successfully triggered with Parameterized Trigger \<= 2.22.
85-
- This is caused by the new behavir introduced in Parameterized Trigger 2.23.
84+
- This is caused by the new behavior introduced in Parameterized Trigger 2.23.
8685
It gets to pass parameter values not directly to the downstream build, but to parameter definitions of downstream projects.
87-
This enables parameter definitions perform its specific process, for example, selecting nodes with NodeLabel Parameter Plugin.
88-
- Example: There is a project with a choice parameter with choices A, B, C.
86+
This enables parameter definitions to perform its specific process, for example, selecting nodes with NodeLabel Parameter Plugin.
87+
- Example: There is a project with a choice parameter with choices A, B, C.
8988
When you triggered that project with parameter value D, it fails with following output in the upstream:
9089

9190
```
9291
java.lang.IllegalArgumentException: Illegal choice: D at
9392
hudson.model.ChoiceParameterDefinition.checkValue(ChoiceParameterDefinition.java:72)
9493
```
9594

96-
- This is taken as a designated behavior.
95+
- This is the intended behavior.
9796
- As those failures are ones designed by parameter definitions.
98-
For example, the choice parameter is designed not to accept unexpected values.
99-
- You will face same problem when you triggered those builds with Jenkins CLI or Remote access API.
97+
For example, the choice parameter is designed to not accept unexpected values.
98+
- The same behavior is visible builds are triggered those with the Jenkins CLI or the remote access API.
10099
- It is recommended to fix your project configuration to have parameter definitions not fail.
101100
- For example, use EnvInject Plugin to process values or use Extensible Choice Parameter Plugin which provides a choice parameter accepting edited values.
102-
103-
##### Workaround
104-
105-
As backward compatibility, you can make it work without fix by setting Java system property `hudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode` to `true`.
106-
It can be done with launching Jenkins as followings:
107101

108-
```
109-
java -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true -jar jenkins.war
110-
```
111-
112-
In RedHat Linux systems, you can modify /etc/sysconfig/jenkins as following:
113-
114-
```
115-
-JENKINS\_JAVA\_OPTIONS="-Djava.awt.headless=true"
116-
+JENKINS\_JAVA\_OPTIONS="-Djava.awt.headless=true -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true"
117-
```
118-
In Debian Linux systems, you can modify /etc/defaults/jenkins as following:
102+
### Workaround
119103

120-
```
121-
-JAVA_ARGS="-Djava.awt.headless=true" # Allow graphs etc. to work even when an X server is present
122-
+JAVA_ARGS="-Djava.awt.headless=true -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true"
123-
```
124-
125-
In Windows system, you can modify jenkins.xml placed in the installed folder.
126-
127-
```
128-
-<arguments>-Xrs -Xmx256m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -jar "%BASE%\\jenkins.war" --httpPort=8080\</arguments>
129-
+\<arguments>-Xrs -Xmx256m -Dhudson.lifecycle=hudson.lifecycle.WindowsServiceLifecycle -Dhudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode=true -jar "%BASE%\\jenkins.war" --httpPort=8080\</arguments>
130-
```
104+
Set the `hudson.plugins.parameterizedtrigger.ProjectSpecificParametersActionFactory.compatibility_mode` Java system property to `true` to restore the old behavior.
105+
Refer to the ["Jenkins features controlled by system properties"](https://www.jenkins.io/doc/book/managing/system-properties/) for detailed instructions on Java system properties in Jenkins.
131106

132-
# Report an issue
107+
## Report an issue
133108

134109
Please report issues and enhancements through the [Jenkins issue tracker](https://www.jenkins.io/participate/report-issue/redirect/#15592).

src/main/resources/hudson/plugins/parameterizedtrigger/CounterBuildParameterFactory/help-validationFail.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
This option determines the behaviour to take if the from,to and step values do not form a valid combination. One that gives a finite number of combinations.<br/>
33
The actions that can be taken are:
44
<ul>
5-
<li><b>Fail the build step</b> This will fail the buildstep with a RuntimeException. (This is the default, and occured in older versions)</li>
5+
<li><b>Fail the build step</b> This will fail the buildstep with a RuntimeException. (This is the default, and occurred in older versions)</li>
66
<li><b>Don't trigger these projects</b> This will cause the projects not to be triggered at all for this configuration.</li>
77
<li><b>Skip these parameters</b> This will allow the projects to be triggered without these parameters.</li>
88
</ul>

src/main/resources/hudson/plugins/parameterizedtrigger/FileBuildParameterFactory/help-noFilesFoundAction.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
The actions that can be taken are:
44
<ul>
55
<li><b>Don't trigger these projects</b> This will cause the projects not to be triggered at all for this configuration. </li>
6-
<li><b>Skip these parameters</b> This will allow the projects to be triggered without these parameters. (This is the default, and occured in older versions)</li>
6+
<li><b>Skip these parameters</b> This will allow the projects to be triggered without these parameters. (This is the default, and occurred in older versions)</li>
77
<li><b>Fail the build step</b> This will fail the buildstep with a RuntimeException.</li>
88
</ul>
99
</div>
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?jelly escape-by-default='true'?>
22
<j:jelly xmlns:j="jelly:core" xmlns:st="jelly:stapler" xmlns:d="jelly:define" xmlns:l="/lib/layout" xmlns:t="/lib/hudson" xmlns:f="/lib/form">
3-
<f:entry field="includeUpstreamParameters" title="${%Include/passthrough Upstream SVN Revisons}">
3+
<f:entry field="includeUpstreamParameters" title="${%Include/passthrough Upstream SVN Revisions}">
44
<f:checkbox default="false" />
55
</f:entry>
66
</j:jelly>

0 commit comments

Comments
 (0)