{"id":15040613,"url":"https://github.com/iteratec/semantic-release-docker","last_synced_at":"2025-08-01T04:42:34.084Z","repository":{"id":32458893,"uuid":"134001167","full_name":"iteratec/semantic-release-docker","owner":"iteratec","description":"a semantic-release plugin to use semver with docker images","archived":false,"fork":false,"pushed_at":"2022-12-30T17:32:30.000Z","size":1429,"stargazers_count":10,"open_issues_count":20,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-27T18:22:10.854Z","etag":null,"topics":["docker","semantic-release-plugin","semver"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","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/iteratec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-18T20:29:08.000Z","updated_at":"2020-08-31T04:28:43.000Z","dependencies_parsed_at":"2023-01-14T21:17:22.152Z","dependency_job_id":null,"html_url":"https://github.com/iteratec/semantic-release-docker","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iteratec%2Fsemantic-release-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iteratec%2Fsemantic-release-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iteratec%2Fsemantic-release-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/iteratec%2Fsemantic-release-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/iteratec","download_url":"https://codeload.github.com/iteratec/semantic-release-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248937194,"owners_count":21186182,"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","semantic-release-plugin","semver"],"created_at":"2024-09-24T20:44:49.412Z","updated_at":"2025-04-14T18:34:03.670Z","avatar_url":"https://github.com/iteratec.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @iteratec/semantic-release-docker\n\n[![Build Status](https://dev.azure.com/iteratec-oss-bdd/semantic-release-docker/_apis/build/status/iteratec.semantic-release-docker?branchName=master)](https://dev.azure.com/iteratec-oss-bdd/semantic-release-docker/_build/latest?definitionId=2\u0026branchName=master)\n[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)\n[![latest npm package version](https://img.shields.io/npm/v/@iteratec/semantic-release-docker/latest.svg)](https://www.npmjs.com/package/@iteratec/semantic-release-docker)\n[![MIT license](https://img.shields.io/npm/l/@iteratec/semantic-release-docker.svg)](https://www.npmjs.com/package/@iteratec/semantic-release-docker)\n\nA [semantic-release](https://github.com/semantic-release/semantic-release) plugin to use semantic versioning for docker images.\n\n## Supported Steps\n\n### verifyConditions\n\nverifies that environment variables for authentication via username and password are set.\nIt uses a registry server provided via config or environment variable (preferred) or defaults to docker hub if none is given.\nIt also verifies that the credentials are correct by logging in to the given registry.\n\n### prepare\n\ntags the specified image with the version number determined by semantic-release and additional tags provided in the configuration.\nIn addition it supports specifying a complete image name (CIN) via configuration settings according to the canonical format specified by docker:\n\n`[registryhostname[:port]/][username/]imagename[:tag]`\n\n### publish\n\npushes the tagged images to the registry.\n\n## Installation\n\nRun `npm i --save-dev @iteratec/semantic-release-docker` to install this semantic-release plugin.\n\n## Configuration\n\n### Docker registry authentication\n\nThe `docker registry` authentication is **required** and can be set via environment variables.\n\n### Environment variables\n\n| Variable                 | Description                                                                               |\n| ------------------------ | ----------------------------------------------------------------------------------------- |\n| DOCKER_REGISTRY_URL      | The hostname and port used by the desired docker registry. Leave blank to use docker hub. |\n| DOCKER_REGISTRY_USER     | The user name to authenticate with at the registry.                                       |\n| DOCKER_REGISTRY_PASSWORD | The password used for authentication at the registry.                                     |\n\n### Options\n\n| Option         | Description                                                                                                                                 |\n| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |\n| additionalTags | _Optional_. An array of strings allowing to specify additional tags to apply to the image.                                                  |\n| imageName      | **_Required_** The name of the image to release.                                                                                            |\n| registryUrl    | _Optional_. The hostname and port used by the the registry in format `hostname[:port]`. Omit the port if the registry uses the default port |\n| repositoryName | _Optional_. The name of the repository in the registry, e.g. username on docker hub                                                         |\n\n## Usage\n\nfull configuration:\n\n```json\n{\n  \"verifyConfig\": [\"@iteratec/semantic-release-docker\"],\n  \"prepare\": {\n    \"path\": \"@iteratec/semantic-release-docker\",\n    \"additionalTags\": [\"test\", \"demo\"],\n    \"imageName\": \"my-image\",\n    \"registryUrl\": \"my-private-registry:5678\",\n    \"respositoryName\": \"my-repository\"\n  },\n  \"publish\": {\n    \"path\": \"@iteratec/semantic-release-docker\"\n  }\n}\n```\n\nresults in `my-private-registry:5678/my-repository/my-image` with tags `test`, `demo` and the `\u003csemver\u003e` determined by `semantic-release`.\n\nminimum configuration:\n\n```json\n{\n  \"verifyConfig\": [\"@iteratec/semantic-release-docker\"],\n  \"prepare\": {\n    \"path\": \"@iteratec/semantic-release-docker\",\n    \"imageName\": \"my-image\"\n  },\n  \"publish\": {\n    \"path\": \"@iteratec/semantic-release-docker\"\n  }\n}\n```\n\nresults in `my-image:\u003csemver\u003e`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiteratec%2Fsemantic-release-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fiteratec%2Fsemantic-release-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fiteratec%2Fsemantic-release-docker/lists"}