{"id":22281986,"url":"https://github.com/jenkinsci/structs-plugin","last_synced_at":"2025-07-31T17:46:00.718Z","repository":{"id":3066035,"uuid":"48337544","full_name":"jenkinsci/structs-plugin","owner":"jenkinsci","description":"Library plugin for DSL plugins that need concise names for Jenkins extensions","archived":false,"fork":false,"pushed_at":"2025-05-30T19:41:32.000Z","size":516,"stargazers_count":11,"open_issues_count":6,"forks_count":35,"subscribers_count":99,"default_branch":"master","last_synced_at":"2025-05-31T04:44:55.396Z","etag":null,"topics":["jenkins-api-plugin"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/structs/","language":"Java","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenkinsci.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-12-20T21:18:38.000Z","updated_at":"2025-05-30T19:34:36.000Z","dependencies_parsed_at":"2024-12-03T16:26:19.856Z","dependency_job_id":"1527d891-ede3-4552-b132-41f0f0bae4a2","html_url":"https://github.com/jenkinsci/structs-plugin","commit_stats":null,"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/jenkinsci/structs-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fstructs-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fstructs-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fstructs-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fstructs-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/structs-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fstructs-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267580497,"owners_count":24110854,"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","status":"online","status_checked_at":"2025-07-28T02:00:09.689Z","response_time":68,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["jenkins-api-plugin"],"created_at":"2024-12-03T16:24:17.765Z","updated_at":"2025-07-28T20:31:43.272Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Structs plugin\n\nLibrary plugin for DSL plugins that need concise names for Jenkins extensions\n\n## Overview\n\nJenkins has many DSL like plugins that require having short concise names for implementations of the extension points and other Jenkins objects. For example, [Job DSL Plugin](https://plugins.jenkins.io/job-dsl) refers to each `SCM` extension by its short name. The same goes for pipeline plugin.\n\nIt benefits users that these DSL plugins use consistent names. This plugin, together with the `@Symbol` annotation, allow plugin developers to name their extension and have all the DSL plugins recognize them.\n\n## Usage for developers creating any plugins\n\nTo allow all the DSL plugins to refer to your extensions by the same name, put `@Symbol` annotation along side your `@Extension`. The symbol name must be a valid Java identifier, and it should be short and concise. To keep the symbol name short, it needs to be only unique within the extension point. For example, `GitSCM` and `GitToolInstaller` should both have a symbol name `git`, because they are from different extension points. For compatibility reasons with DSL plugins that predates the structs plugin, some extensions may have legacy names that do not follow this convention.\n\n``` java\npublic class GitSCM {\n   ...\n\n   @Extension @Symbol(\"git\")\n   public static class DescriptorImpl extends SCMDescriptor {\n      ...\n   }\n}\n```\n\nIf you are targeting 1.x version of Jenkins, you must also add the following dependency to your plugin POM:\n\n``` xml\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.jenkins-ci.plugins\u003c/groupId\u003e\n        \u003cartifactId\u003estructs\u003c/artifactId\u003e\n        \u003cversion\u003e1.2\u003c/version\u003e\n    \u003c/dependency\u003e\n```\n\n## Usage for DSL plugin developers\n\nLook up an extension by its symbol:\n\n``` java\n@Extension @Symbol(\"foo\")\npublic class FooGlobalConfiguration extends GlobalConfiguration {\n   ...\n}\n\n// this yields the FooGlobalConfiguration instance\nSymbolLookup.get().find(GlobalConfiguration.class, \"foo\")\n```\n\nConstruct a `Describable` object from a key/value pairs, much like how [Structured Form Submission](https://wiki.jenkins.io/display/JENKINS/Structured+Form+Submission) does it via `@DataBoundConstructor`:\n\n``` java\nnew DescribableModel(Mailer.class).instantiate(\n        Collections.singletonMap(\"recipients\", \"kk@kohsuke.org\"))\n```\n\n## Version history\n\nPlease refer to the [Changelog](CHANGELOG.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fstructs-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fstructs-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fstructs-plugin/lists"}