This plugin extends the Folders Plugin to provide custom icons for folders. You can upload your own images, use predefined icons or use the combined build status of the jobs within a folder as icon.
Release notes are recorded in GitHub Releases.
-
Version 2.20 introduces a new type of icon. The
UrlFolderIconallows to use a remote URL as icons. -
Version 2.16 requires Jenkins baseline 2.479.x and migrates to Java 17 and Jakarta EE 9.
-
Version 2.14 introduces a new type of icon. The
OpenSourceFolderIconprovides icons from oss-symbols-api-plugin. -
Version 2.11 moved the Global Configuration to the Appearance configuration
Changes in previous versions …
-
Version 2.10 enables users to select the jobs to be considered for the combined build status in
BuildStatusFolderIcon. -
Version 2.9 introduces a new type of icon. The
FontAwesomeFolderIconprovides Font Awesome icons. -
Version 2.6 enables users to select and re-use an already existing
CustomFolderIcon. Further, an icon file will now be deleted automatically if the folder it used is being deleted - unless of course the file is still used by another folder. -
Version 2.5 introduces a new type of icon. The
EmojiFolderIconprovides Unicode emojis as icon. -
Version 2.3 introduces a new type of icon. The
IoniconFolderIconprovides icons from ionicons-api-plugin. -
Version 2.0 introduces a new type of icon. The
BuildStatusFolderIcondisplays the combined build status of the jobs within a folder. -
Since 1.83 of the job-dsl-plugin the Custom Folder Icons Plugin can be used in Job DSL configurations.
Legacy version for Jenkins versions before 2.357.
-
Since 2.1044 of the branch-api-plugin the Custom Folder Icons Plugin can be used for Multi-Branch or Organization Projects.
There are multiple types of custom icons provided by this plugin.
Use your custom icon for a folder.
Select the Custom Folder Icon option and use Browse… to choose a file.
You can crop the image to the desired result and upload it using the Apply button.
The file name will be randomized during upload.
You can also select an image from the list of the already available icons.
The file will be deleted automatically if the folder it used is being deleted - unless of course the file is still used by another folder.
Configuration via job-dsl-plugin:
userContent('customFolderIcons/custom.png', streamFileFromWorkspace('custom.png'))
folder('custom-icon') {
icon {
customFolderIcon {
foldericon('custom.png')
}
}
}
See the combined build status of the jobs within a folder.
Select the Build Status Folder Icon option to use the combined build status of the jobs within a folder as an icon.
You can select which jobs should be considered when the combined build status is determined.
When no jobs are selected, every job within the folder is considered for the combined build status.
Configuration via job-dsl-plugin:
folder('build-status') {
icon {
buildStatusFolderIcon {
jobs(['main', 'dev'] as Set)
}
}
}
Use Unicode emojis as icon.
Select the Emoji Folder Icon option and select any of the available emojis.
Configuration via job-dsl-plugin:
folder('emoji-icon') {
icon {
emojiFolderIcon {
emoji('sloth')
}
}
}
Use Font Awesome Icons provided by font-awesome-api-plugin as icon.
Select the FontAwesome Folder Icon option and select any of the available icons.
Configuration via job-dsl-plugin:
folder('fontawesome-icon') {
icon {
fontAwesomeFolderIcon {
fontAwesome('brands/jenkins')
}
}
}
Use Ionicons provided by ionicons-api-plugin as icon.
Select the Ionicon Folder Icon option and select any of the available icons.
Configuration via job-dsl-plugin:
folder('ionicon-icon') {
icon {
ioniconFolderIcon {
ionicon('jenkins')
}
}
}
Use icons provided by oss-symbols-api-plugin as icon.
Select the OpenSource Folder Icon option and select any of the available icons.
Configuration via job-dsl-plugin:
folder('opensource-icon') {
icon {
openSourceFolderIcon {
ossicon('cdf-icon-color')
}
}
}
Use a remote URL as a source for an icon.
Select the URL Folder Icon option and input the URL to be used as an icon source.
Configuration via job-dsl-plugin:
folder('url-icon') {
icon {
urlFolderIcon {
url('https://get.jenkins.io/art/jenkins-logo/headshot.svg')
}
}
}
