Guide to using Groovy to update the URL of theme CSS in Jenkins?

Question

Guide to using Groovy to update the URL of theme CSS in Jenkins?

Currently, I am attempting to customize the Jenkins user interface by incorporating custom CSS. In order to achieve this, I have placed the CSS file within the userContent folder and have successfully installed the Simple Theme Plugin. I am able to manually modify the URL of the theme's CSS by accessing the configuration page within Jenkins. My goal now is to automate this process using Groovy scripting, but I am encountering challenges in finding the appropriate API for this task. Can anyone confirm if this automation is feasible?

css jenkins groovy

Answer 1

Answer №1

Here is another method that showcases the new configuration layout in the updated UI of simple-theme 0.5.1:

import jenkins.model.Jenkins;
import org.jenkinsci.plugins.simpletheme.CssUrlThemeElement;

Jenkins jenkins = Jenkins.get()

def themeDecorator = jenkins.getExtensionList(org.codefirst.SimpleThemeDecorator.class).first()

themeDecorator.setElements([
  new CssUrlThemeElement('https://some.dummy/url.css')
])

jenkins.save()

If more configuration options are required, simply include object instances within the list for setElements(). Each instance would correspond to an item in the configuration menu. Various classes can be utilized as seen here.

Answer 2

Here is another method that showcases the new configuration layout in the updated UI of simple-theme 0.5.1:

import jenkins.model.Jenkins;
import org.jenkinsci.plugins.simpletheme.CssUrlThemeElement;

Jenkins jenkins = Jenkins.get()

def themeDecorator = jenkins.getExtensionList(org.codefirst.SimpleThemeDecorator.class).first()

themeDecorator.setElements([
  new CssUrlThemeElement('https://some.dummy/url.css')
])

jenkins.save()

If more configuration options are required, simply include object instances within the list for setElements(). Each instance would correspond to an item in the configuration menu. Various classes can be utilized as seen here.

Answer 3

Answer №2

To update the URL for CSS styling or JavaScript files in the SimpleThemeDecorator, simply assign a new URL string to either the cssUrl or jsUrl properties. Setting them to null will reset the URL. Any changes made will be applied immediately.

for (pd in PageDecorator.all()) {
  if (pd instanceof org.codefirst.SimpleThemeDecorator) {
    pd.cssUrl = 'https://...'
  }
}

Answer 4

To update the URL for CSS styling or JavaScript files in the SimpleThemeDecorator, simply assign a new URL string to either the cssUrl or jsUrl properties. Setting them to null will reset the URL. Any changes made will be applied immediately.

for (pd in PageDecorator.all()) {
  if (pd instanceof org.codefirst.SimpleThemeDecorator) {
    pd.cssUrl = 'https://...'
  }
}

Answer 5

Answer №3

A different approach to the problem:

import jenkins.model.Jenkins

YELLOW = '\u001B[33m';
RESET  = '\u001B[0m';

def applyCustomTheme(def descriptor, String cssUrl, String jsUrl) {
    if ( !(cssUrl == null || cssUrl.trim().isEmpty()) ) {
        println("${YELLOW}Applying custom CSS: ${cssUrl.trim()}${RESET}")
        descriptor.cssUrl = cssUrl.trim()
    }
    if ( !(jsUrl == null ||jsUrl.trim().isEmpty()) ) {
        println("${YELLOW}Applying custom JS: ${jsUrl.trim()}${RESET}")
        descriptor.jsUrl = jsUrl.trim()
    }
    descriptor.save()
}

def customCss = System.getenv('CUSTOM_THEME_CSS') ?: null
def customJs  = System.getenv('CUSTOM_THEME_JS')  ?: null

def themeDecorator = Jenkins.getInstance().getDescriptor("org.codefirst.SimpleThemeDecorator")
applyCustomTheme(themeDecorator, customCss, customJs)

Answer 6

A different approach to the problem:

import jenkins.model.Jenkins

YELLOW = '\u001B[33m';
RESET  = '\u001B[0m';

def applyCustomTheme(def descriptor, String cssUrl, String jsUrl) {
    if ( !(cssUrl == null || cssUrl.trim().isEmpty()) ) {
        println("${YELLOW}Applying custom CSS: ${cssUrl.trim()}${RESET}")
        descriptor.cssUrl = cssUrl.trim()
    }
    if ( !(jsUrl == null ||jsUrl.trim().isEmpty()) ) {
        println("${YELLOW}Applying custom JS: ${jsUrl.trim()}${RESET}")
        descriptor.jsUrl = jsUrl.trim()
    }
    descriptor.save()
}

def customCss = System.getenv('CUSTOM_THEME_CSS') ?: null
def customJs  = System.getenv('CUSTOM_THEME_JS')  ?: null

def themeDecorator = Jenkins.getInstance().getDescriptor("org.codefirst.SimpleThemeDecorator")
applyCustomTheme(themeDecorator, customCss, customJs)

Guide to using Groovy to update the URL of theme CSS in Jenkins?

Answer №1

Answer №2

Answer №3

Similar questions

Executing 'npm start' to launch an HTML file along with a CSS stylesheet - A step-by-step guide

Identify all anchor elements that contain image elements

The backstretch slideshow is malfunctioning

Design that is specifically tailored for mobile devices and excludes desktop compatibility

Hiding a Class in Bootstrap 4

"How can I adjust the positioning of a Materialize modal to be at the top

Adjusting the transparency of a div's background using RGBa

Is the PNG image displaying poorly in the IE10 browser?

How to style images in a row using CSS

The button is positioned at the bottom right within a div surrounded by text that flows around it seamlessly

Tips for simultaneously hovering over SVG and text elementsFeel free to hover over both SVG

Assistance needed in Android Studio for incorporating a button using a Style Sheet (CSS)

Customize Bootstrap breadcrumbs with Font Awesome icon divider using SASS

Displaying data from a Mysqli database using PHP

Utilize Flexbox to arrange elements in a column direction without relying on the position property in CSS

Transformation effect when hovering over an SVG polygon as it transitions between two states

Inheriting CSS Styles in a JavaScript Toolbar Plugin

Creating a border with tabs and a triangle using CSS

Having trouble with the toggle button on the Bootstrap 5 navbar?

Mastering the art of reading rows in ASP.NET using Java Script