Supercharge Your Jenkins Jobs: Add Color and Style to Parameters

Want to make your Jenkins job parameters more visually appealing and user-friendly? Tired of the same old boring input fields? This article shows you how to inject custom HTML and JavaScript using the Active Choices plugin to dramatically enhance your "Build with Parameters" page. We'll transform standard Jenkins parameters into something dynamic and engaging.

This can boost user engagement significantly, cut down on errors, and make your Jenkins setup a pleasure to use.

Why Customize Jenkins Job Parameters?

• Improved User Experience: Guide users with visual cues and clear instructions.
• Reduced Errors: Highlight important parameters and make them stand out.
• Increased Engagement: Create a more interactive and intuitive interface.
• Enhanced Clarity: Help users quickly identify the necessary parameters.

The Secret Weapon: Active Choices Plugin and ET_FORMATTED_HTML

The Active Choices plugin gives you the power to inject dynamic content into your Jenkins job configuration. The key is the ET_FORMATTED_HTML parameter type. It allows you to embed HTML (and JavaScript!) directly into the parameter section of your job.

This means you can:

• Add custom styling.
• Implement dynamic behavior.
• Hide/show parameters based on conditions.
• Inject styled instructions.

Step-by-Step Guide: Adding Some Color

Let's dive into a practical example. We'll walk through adding a red background to a specific parameter using the provided code. This uses Groovy scripting within Jenkins.

1. The Groovy Script (getHtmlAdditions):

def getHtmlAdditions() {
return '''
return """
 <style>
 </style>
 <script type="text/javascript">
 jQuery(function() {
 var username = jQuery("input[type=hidden][value=USERNAME]").parents(".tr")
 username.css('background-color', 'red')
 })
 </script>
 """
'''
}

This script uses JavaScript and jQuery to find the parameter labeled "USERNAME" and changes its background color to red.

2. Integrating the Script into your Jenkins Job:

properties([
parameters([
[$class: 'DynamicReferenceParameter',
name: 'HTML_ADDITIONS',
choiceType: 'ET_FORMATTED_HTML',
omitValueField: true,
description: '',
script:
[$class: 'GroovyScript',
fallbackScript: [classpath: [], sandbox: false, script: ''],
script: [classpath: [], sandbox: false, script: getHtmlAdditions()]
]
],
[$class: 'StringParameterDefinition',
name: 'USERNAME',
defaultValue: '',
description: '',
trim: true,
],
[$class: 'StringParameterDefinition',
name: 'GROUP',
defaultValue: '',
description: '',
trim: true,
],
])
])

This configuration defines a DynamicReferenceParameter named "HTML_ADDITIONS" using the ET_FORMATTED_HTML choice type. It calls the getHtmlAdditions() Groovy script to inject the HTML and JavaScript code. This is a key part of tailoring the Jenkins job colorful parameter section to your liking.

3. Script Approvals:

Jenkins will likely require you to approve the Groovy script before it can run. This is a security measure to prevent malicious code from being executed. Go to "Manage Jenkins" -> "In-process Script Approval" to approve the script.

4. The Result:

After you run the job, you'll see that the "USERNAME" parameter now has a red background!

Beyond Color: Hiding Parameters

The example also shows how to hide the "HTML_ADDITIONS" parameter itself, resulting in a cleaner display. JavaScript's hide() function helps you dynamically control parameter visibility.

jQuery("input[type=hidden][value=HTML_ADDITIONS]").parents(".tr").hide()

Long-Tail Keywords and SEO Considerations

We've naturally woven in relevant long-tail keywords like "Jenkins job colorful parameter" and "customize Jenkins job parameters" to help people find this article. We've also addressed the intent behind customizing parameters for a targeted audience.

Take Action: Start Customizing Today!

By leveraging the Active Choices plugin and ET_FORMATTED_HTML, you can transform your Jenkins job parameters from boring to brilliant. Experiment with different styling, dynamic behavior, and parameter visibility to create a more user-friendly and efficient workflow.

Next Steps:

• Install the Active Choices plugin.
• Experiment with different HTML and JavaScript code.
• Explore other features of the Active Choices plugin
• Check out the Active Choices Plugin documentation - https://plugins.jenkins.io/active-choices/

Elevate your Jenkins experience by using a Jenkins job colorful parameter section, and watch your team's productivity soar!