{"id":27243739,"url":"https://github.com/jenkinsci/custom-folder-icon-plugin","last_synced_at":"2025-04-10T20:58:23.018Z","repository":{"id":37463085,"uuid":"294157391","full_name":"jenkinsci/custom-folder-icon-plugin","owner":"jenkinsci","description":"Plugin to customize Jenkins Folder icons","archived":false,"fork":false,"pushed_at":"2025-04-09T17:19:13.000Z","size":10016,"stargazers_count":8,"open_issues_count":2,"forks_count":9,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-09T18:34:18.382Z","etag":null,"topics":["build","build-jenkins","build-status","custom","emoji","emoji-unicode","folder","font-awesome","icon","ionicons","jenkins","jenkins-plugin","jenkins-security-scan-enabled","plugin","sloth","ui"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/custom-folder-icon","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenkinsci.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2020-09-09T15:42:22.000Z","updated_at":"2025-04-09T17:19:16.000Z","dependencies_parsed_at":"2023-10-02T23:16:50.119Z","dependency_job_id":"6d859ea6-cdc3-4668-8492-eb5e119185d9","html_url":"https://github.com/jenkinsci/custom-folder-icon-plugin","commit_stats":null,"previous_names":[],"tags_count":26,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcustom-folder-icon-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcustom-folder-icon-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcustom-folder-icon-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fcustom-folder-icon-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/custom-folder-icon-plugin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248298435,"owners_count":21080318,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["build","build-jenkins","build-status","custom","emoji","emoji-unicode","folder","font-awesome","icon","ionicons","jenkins","jenkins-plugin","jenkins-security-scan-enabled","plugin","sloth","ui"],"created_at":"2025-04-10T20:58:22.490Z","updated_at":"2025-04-10T20:58:23.003Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"[[custom-folder-icon-plugin]]\n= Custom Folder Icon Plugin\n:toc: macro\n:toclevels: 3\n:toc-title:\n\nimage:https://ci.jenkins.io/job/Plugins/job/custom-folder-icon-plugin/job/main/badge/icon[link=\"https://ci.jenkins.io/job/Plugins/job/custom-folder-icon-plugin/job/main/\"]\nimage:https://codecov.io/gh/jenkinsci/custom-folder-icon-plugin/branch/main/graph/badge.svg[link=\"https://codecov.io/gh/jenkinsci/custom-folder-icon-plugin\"]\nimage:https://github.com/jenkinsci/custom-folder-icon-plugin/actions/workflows/jenkins-security-scan.yml/badge.svg[link=\"https://github.com/jenkinsci/custom-folder-icon-plugin/actions/workflows/jenkins-security-scan.yml\"]\n\nimage:https://img.shields.io/jenkins/plugin/i/custom-folder-icon.svg?color=blue\u0026label=installations[link=\"https://stats.jenkins.io/pluginversions/custom-folder-icon.html\"]\nimage:https://img.shields.io/github/contributors/jenkinsci/custom-folder-icon-plugin.svg?color=blue[link=\"https://github.com/jenkinsci/custom-folder-icon-plugin/graphs/contributors\"]\nimage:https://img.shields.io/github/release/jenkinsci/custom-folder-icon-plugin.svg?label=changelog[link=\"https://github.com/jenkinsci/custom-folder-icon-plugin/releases/latest\"]\n\n== Introduction\n\nThis plugin extends the https://github.com/jenkinsci/cloudbees-folder-plugin[Folders Plugin] to provide custom icons for folders.\nYou can upload your own images, use predefined icons or use the combined build status of the jobs within a folder as icon.\n\ntoc::[]\n\n== Changelog\n\nRelease notes are recorded in https://github.com/jenkinsci/custom-folder-icon-plugin/releases[GitHub Releases].\n\n=== Version 2.x\n\n* Version 2.16 requires Jenkins baseline 2.479.x and migrates to Java 17 and Jakarta EE 9.\n* Version 2.14 introduces a new type of icon.\nThe `OpenSourceFolderIcon` provides icons from https://github.com/jenkinsci/oss-symbols-api-plugin[oss-symbols-api-plugin].\n* Version 2.11 moved the \u003c\u003cGlobal Configuration\u003e\u003e to the _Appearance_ configuration\n\n.Changes in previous versions ...\n[%collapsible]\n====\n* Version 2.10 enables users to select the jobs to be considered for the combined build status in `BuildStatusFolderIcon`.\n* Version 2.9 introduces a new type of icon.\nThe `FontAwesomeFolderIcon` provides https://fontawesome.com[Font Awesome] icons.\n* Version 2.6 enables users to select and re-use an already existing `CustomFolderIcon`.\nFurther 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.\n* Version 2.5 introduces a new type of icon.\nThe `EmojiFolderIcon` provides https://unicode.org/emoji/charts/full-emoji-list.html[unicode emojis] as icon.\n* Version 2.3 introduces a new type of icon.\nThe `IoniconFolderIcon` provides icons from https://github.com/jenkinsci/ionicons-api-plugin[ionicons-api-plugin].\n* Version 2.0 introduces a new type of icon.\nThe `BuildStatusFolderIcon` displays the combined build status of the jobs within a folder.\n* Since https://github.com/jenkinsci/job-dsl-plugin/releases/tag/job-dsl-1.83[1.83] of the https://github.com/jenkinsci/job-dsl-plugin[job-dsl-plugin] the Custom Folder Icons Plugin can be used in Job DSL configurations.\n====\n\n=== Version 1.x\n\nLegacy version for Jenkins versions before 2.357.\n\n* Since https://github.com/jenkinsci/branch-api-plugin/releases/tag/2.1044.v2c007e51b_87f[2.1044] of the https://github.com/jenkinsci/branch-api-plugin[branch-api-plugin] the Custom Folder Icons Plugin can be used for Multi-Branch or Organization Projects.\n\n== Configuration\n\n=== Folder Configuration\n\nThere are multiple types of custom icons provided by this plugin.\n\nimage:docs/overview.png[]\n\n==== Custom Folder Icon\n\nUse your custom icon for a folder.\n\nimage:docs/custom-folder-icon.png[]\n\nSelect the _Custom Folder Icon_ option and use `Browse...` to choose a file.\n\nYou can crop the image to the desired result and upload it using the `Apply` button.\n\nThe file name will be randomized during upload.\n\nYou can also select an image from the list of the already available icons.\n\nThe file will be deleted automatically if the folder it used is being deleted - unless of course the file is still used by another folder.\n\nimage:docs/custom-folder-icon-configuration.png[]\n\n===== Job DSL\n\nConfiguration via https://github.com/jenkinsci/job-dsl-plugin[job-dsl-plugin]:\n\n[source,groovy]\n----\nuserContent('customFolderIcons/custom.png', streamFileFromWorkspace('custom.png'))\n\nfolder('custom-icon') {\n    icon {\n        customFolderIcon {\n            foldericon('custom.png')\n        }\n    }\n}\n----\n\n==== Build Status Folder Icon\n\nSee the combined build status of the jobs within a folder.\n\nimage:docs/build-status-folder-icon.png[]\n\nSelect the _Build Status Folder Icon_ option to use the combined build status of the jobs within a folder as icon.\n\nYou can select which jobs should be considered when the combined build status is determined.\n\nWhen no jobs are selected every job within the folder is considered for the combined build status.\n\nimage:docs/build-status-folder-icon-configuration.png[]\n\n===== Job DSL\n\nConfiguration via https://github.com/jenkinsci/job-dsl-plugin[job-dsl-plugin]:\n\n[source,groovy]\n----\nfolder('build-status') {\n    icon {\n        buildStatusFolderIcon {\n            jobs(['main', 'dev'] as Set)\n        }\n    }\n}\n----\n\n==== Emoji Folder Icon\n\nUse https://github.com/jenkinsci/emoji-symbols-api-plugin[Unicode emojis] as icon.\n\nimage:docs/emoji-folder-icon.png[]\n\nSelect the _Emoji Folder Icon_ option and select any of the available emojis.\n\nimage:docs/emoji-folder-icon-configuration.png[]\n\n===== Job DSL\n\nConfiguration via https://github.com/jenkinsci/job-dsl-plugin[job-dsl-plugin]:\n\n[source,groovy]\n----\nfolder('emoji-icon') {\n    icon {\n        emojiFolderIcon {\n            emoji('sloth')\n        }\n    }\n}\n----\n\n==== FontAwesome Folder Icon\n\nUse https://fontawesome.com[Font Awesome Icons] provided by https://github.com/jenkinsci/font-awesome-api-plugin[font-awesome-api-plugin] as icon.\n\nimage:docs/fontawesome-folder-icon.png[]\n\nSelect the _FontAwesome Folder Icon_ option and select any of the available icons.\n\nimage:docs/fontawesome-folder-icon-configuration.png[]\n\n===== Job DSL\n\nConfiguration via https://github.com/jenkinsci/job-dsl-plugin[job-dsl-plugin]:\n\n[source,groovy]\n----\nfolder('fontawesome-icon') {\n    icon {\n        fontAwesomeFolderIcon {\n            fontAwesome('brands/jenkins')\n        }\n    }\n}\n----\n\n==== Ionicon Folder Icon\n\nUse https://ionic.io/ionicons[Ionicons] provided by https://github.com/jenkinsci/ionicons-api-plugin[ionicons-api-plugin] as icon.\n\nimage:docs/ionicon-folder-icon.png[]\n\nSelect the _Ionicon Folder Icon_ option and select any of the available icons.\n\nimage:docs/ionicon-folder-icon-configuration.png[]\n\n===== Job DSL\n\nConfiguration via https://github.com/jenkinsci/job-dsl-plugin[job-dsl-plugin]:\n\n[source,groovy]\n----\nfolder('ionicon-icon') {\n    icon {\n        ioniconFolderIcon {\n            ionicon('jenkins')\n        }\n    }\n}\n----\n\n==== OpenSource Folder Icon\n\nUse icons provided by https://github.com/jenkinsci/oss-symbols-api-plugin[oss-symbols-api-plugin] as icon.\n\nimage:docs/oss-folder-icon.png[]\n\nSelect the _OpenSource Folder Icon_ option and select any of the available icons.\n\nimage:docs/oss-folder-icon-configuration.png[]\n\n===== Job DSL\n\nConfiguration via https://github.com/jenkinsci/job-dsl-plugin[job-dsl-plugin]:\n\n[source,groovy]\n----\nfolder('opensource-icon') {\n    icon {\n        openSourceFolderIcon {\n            ossicon('cdf-icon-color')\n        }\n    }\n}\n----\n\n=== Global Configuration\n\nCheck for unused custom folder icon files and delete them.\nThis operation will delete all images that are currently not used by any folder configuration.\n\nimage:docs/global-configuration.png[]\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fcustom-folder-icon-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fcustom-folder-icon-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fcustom-folder-icon-plugin/lists"}