73 lines
4.8 KiB
Markdown
73 lines
4.8 KiB
Markdown
# buildctl Plugin
|
|
|
|
[](https://hub.docker.com/repository/docker/kokuwaio/buildctl)
|
|
[](https://hub.docker.com/repository/docker/kokuwaio/buildctl)
|
|
[](https://github.com/kokuwaio/buildctl/blob/main/Dockerfile)
|
|
[](https://github.com/kokuwaio/buildctl/blob/main/LICENSE)
|
|
[](https://github.com/kokuwaio/buildctl/issues)
|
|
|
|
A [Woodpecker CI](https://woodpecker-ci.org) plugin for [buildctl](https://github.com/moby/buildkit) to build container images using a remote buildkit instance.
|
|
Also usable with Gitlab, Github or locally, see examples for usage.
|
|
|
|
## Features
|
|
|
|
- preconfigure buildctl parameters
|
|
- searches for yaml files recursive
|
|
- runnable with local docker daemon
|
|
|
|
## Example
|
|
|
|
Woodpecker:
|
|
|
|
```yaml
|
|
steps:
|
|
buildctl:
|
|
image: kokuwaio/buildctl
|
|
depends_on: []
|
|
settings:
|
|
no-warnings: true
|
|
format: json
|
|
when:
|
|
event: pull_request
|
|
path: [.buildctl.yaml, "**/*.y*ml"]
|
|
```
|
|
|
|
Gitlab:
|
|
|
|
```yaml
|
|
buildctl:
|
|
stage: lint
|
|
needs: []
|
|
image: kokuwaio/buildctl
|
|
variables:
|
|
PLUGIN_NO_WARNINGS: true
|
|
PLUGIN_FORMAT: json
|
|
rules:
|
|
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
|
|
changes: [.buildctl.yaml, "**/*.y*ml"]
|
|
```
|
|
|
|
CLI:
|
|
|
|
```bash
|
|
docker run --rm --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/buildctl --no-warnings --format=json
|
|
```
|
|
|
|
## Settings
|
|
|
|
| Settings Name | Environment | Default | Description |
|
|
| --------------| ------------------ | --------- | -------------------------------------------------------------------- |
|
|
| `config-file` | PLUGIN_CONFIG_FILE | `none` | Configuration file to use, if none is configured [default](https://buildctl.readthedocs.io/en/stable/configuration.html) is used |
|
|
| `strict` | PLUGIN_STRICT | `true` | Fail on warnings |
|
|
| `no-warnings` | PLUGIN_NO_WARNINGS | `false` | Output only error level problems |
|
|
| `format` | PLUGIN_FORMAT | `colored` | Format for parsing output: parsable, standard, colored, github, auto |
|
|
|
|
## Alternatives
|
|
|
|
| Image | Comment | amd64 | arm64 |
|
|
| ----------------------------------------------------------------------------------- | --------------------------------- |:-----:|:-----:|
|
|
| [kokuwaio/buildctl](https://hub.docker.com/r/kokuwaio/buildctl) | Woodpecker plugin | [](https://hub.docker.com/repository/docker/kokuwaio/buildctl) | [](https://hub.docker.com/repository/docker/kokuwaio/buildctl) |
|
|
| [pipelinecomponents/buildctl](https://hub.docker.com/r/pipelinecomponents/buildctl) | not a Woodpecker plugin | [](https://hub.docker.com/repository/docker/pipelinecomponents/buildctl) | [](https://hub.docker.com/repository/docker/pipelinecomponents/buildctl) |
|
|
| [giantswarm/buildctl](https://hub.docker.com/r/giantswarm/buildctl) | not a Woodpecker plugin | [](https://hub.docker.com/repository/docker/giantswarm/buildctl) | [](https://hub.docker.com/repository/docker/giantswarm/buildctl) |
|
|
| [cytopia/buildctl](https://hub.docker.com/r/sdesbure/buildctl) | not a Woodpecker plugin, outdated | [](https://hub.docker.com/repository/docker/cytopia/buildctl) | [](https://hub.docker.com/repository/docker/cytopia/buildctl) |
|
|
| [sdesbure/buildctl](https://hub.docker.com/r/sdesbure/buildctl) | not a Woodpecker plugin, outdated | [](https://hub.docker.com/repository/docker/sdesbure/buildctl) | [](https://hub.docker.com/repository/docker/sdesbure/buildctl) |
|