Docker Datasource¶
Table of values¶
| Name | Value | Notes |
|---|---|---|
| Identifier | docker |
|
| Default versioning | docker |
|
| Custom registry support | Yes | |
| Release timestamp support | Yes | The release timestamp is determined from the tag_last_pushed field in thre results. |
| Source URL support | Yes | The source URL is determined from the org.opencontainers.image.source and org.label-schema.vcs-url labels present in the metadata of the latest stable image found on the Docker registry. |
Description¶
This datasource identifies an image's source repository according to the pre-defined annotation keys of the OCI Image Format Specification.
This datasource looks for the metadata of the latest stable image found on the Docker registry and uses the value of the label org.opencontainers.image.source and org.label-schema.vcs-url as the sourceUrl.
Additionally, it uses the value of the label org.opencontainers.image.revision as the gitRef.
The Label Schema is superseded by OCI annotations, use the org.opencontainers.image.source label if possible.
If you maintain a Docker image and want Renovate to find your changelogs, add a org.opencontainers.image.source field to your Dockerfile.
The link must point to your GitHub or GitLab repository.
Here's an example from our renovate/renovate Dockerfile:
LABEL org.opencontainers.image.source="https://github.com/renovatebot/renovate"
If you use Harbor as a proxy cache for Docker Hub, then you must use Harbor version 2.5.0 or higher.
Default configuration¶
{
"commitMessageTopic": "{{{depName}}} Docker tag",
"commitMessageExtra": "to {{#if isPinDigest}}{{{newDigestShort}}}{{else}}{{#if isMajor}}{{{prettyNewMajor}}}{{else}}{{{prettyNewVersion}}}{{/if}}{{/if}}",
"digest": {
"branchTopic": "{{{depNameSanitized}}}-{{{currentValue}}}",
"commitMessageExtra": "to {{newDigestShort}}",
"commitMessageTopic": "{{{depName}}}{{#if currentValue}}:{{{currentValue}}}{{/if}} Docker digest",
"group": {
"commitMessageTopic": "{{{groupName}}}",
"commitMessageExtra": ""
}
},
"pin": {
"commitMessageExtra": "",
"groupName": "Docker digests",
"group": {
"commitMessageTopic": "{{{groupName}}}",
"branchTopic": "digests-pin"
}
}
}
Open items¶
The below list of features were current when this page was generated on December 21, 2024.