{"id":19305913,"url":"https://github.com/jenkinsci/docker-commons-plugin","last_synced_at":"2025-04-05T05:05:33.120Z","repository":{"id":30023419,"uuid":"33572296","full_name":"jenkinsci/docker-commons-plugin","owner":"jenkinsci","description":"API plugin, which provides the common shared functionality for various Docker-related plugins.","archived":false,"fork":false,"pushed_at":"2025-03-11T07:07:46.000Z","size":627,"stargazers_count":45,"open_issues_count":6,"forks_count":77,"subscribers_count":102,"default_branch":"master","last_synced_at":"2025-03-29T04:09:40.051Z","etag":null,"topics":["docker","jenkins","jenkins-api-plugin","jenkins-plugin"],"latest_commit_sha":null,"homepage":"https://plugins.jenkins.io/docker-commons/","language":"Java","has_issues":false,"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.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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}},"created_at":"2015-04-07T22:49:23.000Z","updated_at":"2025-03-11T05:39:44.000Z","dependencies_parsed_at":"2024-03-28T22:34:25.429Z","dependency_job_id":"643a1292-fd9c-438e-9a86-7626f9ff8a2a","html_url":"https://github.com/jenkinsci/docker-commons-plugin","commit_stats":null,"previous_names":[],"tags_count":45,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fdocker-commons-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fdocker-commons-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fdocker-commons-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenkinsci%2Fdocker-commons-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenkinsci","download_url":"https://codeload.github.com/jenkinsci/docker-commons-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247289426,"owners_count":20914464,"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":["docker","jenkins","jenkins-api-plugin","jenkins-plugin"],"created_at":"2024-11-10T00:03:01.783Z","updated_at":"2025-04-05T05:05:33.104Z","avatar_url":"https://github.com/jenkinsci.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Docker Commons API Plugin for Jenkins\n\n[![Join the chat at https://gitter.im/jenkinsci/docker](https://badges.gitter.im/jenkinsci/docker.svg)](https://gitter.im/jenkinsci/docker?utm_source=badge\u0026utm_medium=badge\u0026utm_campaign=pr-badge\u0026utm_content=badge)\n\nAPI plugin, which provides the common shared functionality for various Docker-related plugins.\n\n## Summary\n\n* API for managing Docker image and container fingerprints\n* Credentials and location of Docker Registry\n* Credentials and location of Docker Daemon (aka Docker Remote API)\n* \u003ccode\u003eToolInstallation\u003c/code\u003e for Docker CLI clients\n* \u003ccode\u003eDockerImageExtractor\u003c/code\u003e extension point to get Docker image relations from jobs\n* Simple UI referring related image fingerprints in Docker builds\n* etc.\n\n## Use-cases\n\n### Credentials and locations\n\nThis allows users to configure one set of endpoint/credentials and use it across all the Docker related plugins, \nthereby keeping configuration more [DRY](http://en.wikipedia.org/wiki/Don%27t_repeat_yourself).\n\nSee [Docker Pipeline Plugin](https://plugins.jenkins.io/docker-workflow) for the typical usage.\n\n## Declarative pipeline example\n\nAn example on how to bind Docker host/daemon credentials in a declarative pipeline: \n\n```groovy\npipeline {\n  agent any\n  tools {\n    // a bit ugly because there is no `@Symbol` annotation for the DockerTool\n    // see the discussion about this in PR 77 and PR 52: \n    // https://github.com/jenkinsci/docker-commons-plugin/pull/77#discussion_r280910822\n    // https://github.com/jenkinsci/docker-commons-plugin/pull/52\n    'org.jenkinsci.plugins.docker.commons.tools.DockerTool' '18.09'\n  }\n  environment {\n    DOCKER_CERT_PATH = credentials('id-for-a-docker-cred')\n  }\n  stages {\n    stage('foo') {\n      steps {\n        sh \"docker version\" // DOCKER_CERT_PATH is automatically picked up by the Docker client\n      }\n    }\n  }\n}\n```\n\n## License\n\n[MIT License](http://opensource.org/licenses/MIT)\n\n## Changelog\n\n* See [GitHub Releases](https://github.com/jenkinsci/docker-commons-plugin/releases/latest) for the recent versions\n* See [the release notes archive](https://github.com/jenkinsci/docker-commons-plugin/blob/2e09f1fe61389ef9a967a2bd362bc9d141807c86/CHANGELOG.md) for version `1.15` and older\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fdocker-commons-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenkinsci%2Fdocker-commons-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenkinsci%2Fdocker-commons-plugin/lists"}