https://github.com/theopenlane/docker-metadata-buildkite-plugin
buildkite plugin for creating and storing docker metadata in build pipeline
https://github.com/theopenlane/docker-metadata-buildkite-plugin
buildkite buildkite-plugin docker
Last synced: 6 months ago
JSON representation
buildkite plugin for creating and storing docker metadata in build pipeline
- Host: GitHub
- URL: https://github.com/theopenlane/docker-metadata-buildkite-plugin
- Owner: theopenlane
- License: apache-2.0
- Created: 2024-08-25T00:11:57.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-14T20:59:49.000Z (9 months ago)
- Last Synced: 2025-03-28T17:57:42.361Z (6 months ago)
- Topics: buildkite, buildkite-plugin, docker
- Language: Shell
- Homepage:
- Size: 31.3 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://buildkite.com/theopenlane/docker-metadata-buildkite-plugin)
# docker-metadata
This Buildkite plugin applies a base set of tags and labels to Docker images. Results will be stored in a directory. The directory's path can be found in the `DOCKER_METADATA_DIR` environment variable.
Labels will be accessible through the `DOCKER_METADATA_DIR/labels` directory; tags will be accessible through the `DOCKER_METADATA_DIR/tags` directory. To parse them, iterate over each file's lines.
## Example
Add the following to your `pipeline.yml`:
```yml
steps:
- command: ls
plugins:
- theopenlane/docker-metadata#v1.0.0:
images:
- 'theopenlane/core'
```
The default settings will create a tag with the git commit SHA. (e.g. `theopenlane/image:12345678`).
Also, the image will be labeled with the following labels:
- `org.opencontainers.image.source=$BUILDKITE_REPO`
- `org.opencontainers.image.revision=$BUILDKITE_COMMIT`
- `org.opencontainers.image.created=`
## Configuration
### `images` (Required, array)
The image or set of images to build
### `extra_tags` (Optional, array)
An extra set of tags to add to the image. E.g. `latest` or `dev`
### `tag_prefix` (Optional, string)
Prefix all tags with provided string
### `title` (Optional, string)
The title of the image. This will be persisted as the `org.opencontainers.image.title` label
### `licenses` (Optional, string)
The licenses of the image. This will be persisted as the `org.opencontainers.image.licenses` label
### `vendor` (Optional, string)
The vendor of the image. This will be persisted as the `org.opencontainers.image.vendor` label
### `debug` (Optional, boolean)
Enable debug logging for this plugin
## Developing
Requires [taskfile](https://taskfile.dev/installation/) - `task lint` and `task test` to validate updates to the plugin