Skip to content

jenkinsci/simple-theme-plugin

Repository files navigation

Simple Theme Plugin for Jenkins

Jenkins Plugin GitHub release Jenkins Plugin Installs Build Status GitHub license Maintenance

This plugin allows to customize Jenkin's appearance with custom CSS and JavaScript. It also allows to replace the Favicon.

For a more user-centric approch to theming, take a look at the Theme Manager plugin.

Themes

Some themes can be found on GitHub, but most of them weren't updated in multiple years, so I removed them from this README.

Authors

  • @TobiX
  • @mallowlabs

Contributing

If you want to contribute to this plugin, you probably will need a Jenkins plugin developement environment. This basically means a current version of Java (Java 17 should probably be okay for now) and Apache Maven. See the Jenkins Plugin Tutorial for details.

If you have the proper environment, typing:

$ mvn verify

should create a plugin as target/*.hpi, which you can install in your Jenkins instance. Running

$ mvn hpi:run -Djenkins.version=2.452.2

allows you to spin up a test Jenkins instance on localhost to test your local changes before commiting.

Code Style

This plugin uses the Google Java Code Style, please try to adhere to that style whenever adding new files or making changes to existing files. The style is enforced using the spotless plugin, if the build fails because you were using the "wrong" style, you can fix it by running:

$ mvn spotless:apply

to reformat Java code in the proper style.

License

The MIT License (MIT)

  • Copyright (c) 2011 mallowlabs
  • Copyright (c) 2018-2022 TobiX

See LICENSE

Changelog