Custom Folder Icon Plugin

Introduction

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.

• Introduction
• Changelog
  • Version 2.x
  • Version 1.x
• Configuration
  • Folder Configuration
    • Custom Folder Icon
    • Build Status Folder Icon
    • Ionicon Folder Icon
  • Global Configuration

Changelog

Release notes are recorded in GitHub Releases.

Version 2.x

This version requires Jenkins 2.357 and above in order to support the transition to Java 11.

• Once #1258 of the job-dsl-plugin is merged the Custom Folder Icons Plugin can be used in Job DSL configurations.

• Version 2.3 introduces a new type of icon. The IoniconFolderIcon provides icons from ionicons-api-plugin.

• Version 2.0 introduces a new type of icon. The BuildStatusFolderIcon displays the combined build status of the jobs within a folder.

Version 1.x

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.

Configuration

Folder Configuration

There are multiple types of custom icons provided by this plugin.

Custom Folder Icon

Use your custom icon for a folder.

Select the Custom Folder Icon option and use "Browse…​" to chose 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.

Job DSL

Configuration via job-dsl-plugin:

userContent('customFolderIcons/custom.png', streamFileFromWorkspace('custom.png'))

folder('custom') {
  icon {
    customFolderIcon {
      foldericon('custom.png')
    }
  }
}

Build Status Folder Icon

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 icon.

Job DSL

Configuration via job-dsl-plugin:

folder('build-status') {
  icon {
      buildStatusFolderIcon()
  }
}

Ionicon Folder Icon

Use Ionicons provided by ionicons-api-plugin as icon.

Select the Ionicon Folder Icon option and select any of the available icons.

Job DSL

Configuration via job-dsl-plugin:

folder('ionicon') {
  icon {
    ioniconFolderIcon {
      ionicon('jenkins')
    }
  }
}

Global Configuration

Check for unused custom folder icon files and delete them. This operation will delete all images that are currently not used by any folder configuration.