Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jenkinsci/multiselect-parameter-plugin
The Multiselect parameter plugin is an extension to Jenkins parameterized builds. It allows Jenkins users to create more complex variables consisting of a configurable number of interdependent drop down boxes.
https://github.com/jenkinsci/multiselect-parameter-plugin
jenkins jenkins-plugin parameter
Last synced: 5 days ago
JSON representation
The Multiselect parameter plugin is an extension to Jenkins parameterized builds. It allows Jenkins users to create more complex variables consisting of a configurable number of interdependent drop down boxes.
- Host: GitHub
- URL: https://github.com/jenkinsci/multiselect-parameter-plugin
- Owner: jenkinsci
- License: mit
- Created: 2020-10-07T16:59:29.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T09:19:52.000Z (6 months ago)
- Last Synced: 2025-01-30T06:11:15.170Z (11 days ago)
- Topics: jenkins, jenkins-plugin, parameter
- Language: Java
- Homepage: https://plugins.jenkins.io/multiselect-parameter/
- Size: 739 KB
- Stars: 4
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Multiselect Parameter Plugin
[](https://ci.jenkins.io/job/Plugins/job/multiselect-parameter-plugin/job/main/)
[](https://github.com/jenkinsci/multiselect-parameter-plugin/graphs/contributors)
[](https://plugins.jenkins.io/multiselect-parameter)
[](https://github.com/jenkinsci/multiselect-parameter-plugin/releases/latest)
[](https://plugins.jenkins.io/multiselect-parameter)
[](https://codecov.io/github/swesteme/multiselect-parameter-plugin)
## Introduction
The Multiselect parameter plugin is an extension to Jenkins parameterized builds. It allows Jenkins users to
create more complex variables consisting of a configurable number of interdependent drop-down boxes.
## Getting started
As soon as the plugin has been installed in Jenkins, parameterized jobs offer a new type of build parameters,
named "Multiselect parameter".
There are two configuration variants described below: one for *standard* Jenkins jobs, one for the popular *pipelines*,
which allow for programmatic job configuration.
### "Standard" job configuration
A simple configuration form allows the setup of a parameter name, a description
and a CSV configuration to use in creation of dependency tree.
There are four different types of rows used to describe the parameter and its values/variables:
* H: header labels for the drop-down boxes, one per variable
* V: variable names used as environment variables in build process
* T: titles for the content items in the following row (optional, fallback is the content itself as a label)
* C: the content items that will be passed in the environment variables upon selection
The rows "H" and "V" only appear once as first and second row. The rows "T" and "C" are repeated.
Note: the "T" rows are optional, but may be useful for more technical content values that need a little bit of extra
explanation.
#### Example
In the following simple example, the "build with parameters" step requests to select a favourite team in
a number of sports categories and countries.
```csv
H,Sport,Team
V,SELECTED_SPORT,SELECTED_TEAM
C,Tennis,Tennisclub Rumeln-Kaldenhausen e. V.
T,,Alternative label
C,Tennis,Oppumer TC
C,Football,Rumelner TV
C,Football,FC Rumeln
C,Wakeboard,WSC Duisburg Rheinhausen
```
This will display two drop-down boxes. One with the label "Sport", one with the label "Team".
The first drop-down box contains the values "Tennis", "Football" and "Wakeboard", the second will only hold the values "
Tennisclub Rumeln-Kaldenhausen e. V." and "Oppumer TC".
When the first value is switched to "Wakeboard", the second drop-down boxes content will change to "WSC Duisburg
Rheinhausen".
As soon as the build is started, the environment variables SELECTED_SPORT and SELECTED_TEAM will contain the selected
values.
### Pipeline job configuration
The same example from above would be configured in a tree-structure, which can be created programmatically and resembles
the internal structure that would be created from CSV internally.
The light blue box shows the definition and configuration of the first drop-down box. The purple box shows the
definition of values for the second drop-down box. Note that this is a simple example with only two combo boxes. It is
possible to define any number of variable descriptions here, in which case the items in the purple boxes would also
get "children".
#### Example
The following source code shows the example as complete (very simple) pipeline script.
```groovy
pipeline {
agent any
stages {
stage('Parameters') {
steps {
script {
properties([
parameters([
multiselect(
decisionTree: [
variableDescriptions: [
[
label : 'Sport',
variableName: 'SELECTED_SPORT'
],
[
label : 'Team',
variableName: 'SELECTED_TEAM'
]
],
itemList: [
[children: [
[value: 'Tennisclub Rumeln-Kaldenhausen e. V.'],
[label: 'Alternative label', value: 'Oppumer TC']
],
value : 'Tennis'
],
[children: [
[value: 'Rumelner TV'],
[value: 'FC Rumeln']
],
value : 'Football'],
[children: [
[value: 'WSC Duisburg Rheinhausen']
],
value : 'Wakeboard']
]
],
description: 'Please select your favourite team!',
name: 'Favourite team'
)
])
])
}
}
}
stage('Print variables') {
steps {
sh 'set'
}
}
}
}
```