Initial draft of plugin.
All checks were successful
All checks were successful
This commit is contained in:
parent
86c019716e
commit
236588001b
SSH key fingerprint:
SHA256:99zuzxNGFb5/5P+E/O7ONU2qhUojUe/D8rIPTW+9Xp0
16 changed files with 804 additions and 0 deletions
13
.github/README.md
vendored
Normal file
13
.github/README.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# Buildctl WoodpeckerCI Plugin
|
||||
|
||||
[](https://hub.docker.com/r/kokuwaio/buildctl)
|
||||
[](https://hub.docker.com/r/kokuwaio/buildctl)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/src/branch/main/Dockerfile)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/src/branch/main/LICENSE)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/pulls)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/issues)
|
||||
|
||||
A [WoodpeckerCI](https://woodpecker-ci.org) plugin for [buildctl](https://github.com/moby/buildkit) to build container images using a remote buildkit host.
|
||||
Also usable with Gitlab, Github or locally, see examples for usage.
|
||||
|
||||
For more documention see: [git.kokuwa.io/woodpecker/buildctl](https://git.kokuwa.io/woodpecker/buildctl)
|
||||
15
.github/workflows/build.yaml
vendored
Normal file
15
.github/workflows/build.yaml
vendored
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
name: Build
|
||||
|
||||
on: push
|
||||
|
||||
jobs:
|
||||
|
||||
buildx:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- uses: docker/setup-qemu-action@master
|
||||
- uses: docker/setup-buildx-action@master
|
||||
- uses: docker/build-push-action@master
|
||||
with:
|
||||
platforms: linux/amd64,linux/arm64
|
||||
35
.github/workflows/lint.yaml
vendored
Normal file
35
.github/workflows/lint.yaml
vendored
Normal file
|
|
@ -0,0 +1,35 @@
|
|||
name: Lint
|
||||
|
||||
on: push
|
||||
|
||||
jobs:
|
||||
|
||||
renovate:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- uses: docker://kokuwaio/renovate-config-validator
|
||||
|
||||
markdownlint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- uses: docker://kokuwaio/markdownlint
|
||||
|
||||
yamllint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- uses: docker://kokuwaio/yamllint
|
||||
|
||||
hadolint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- uses: docker://kokuwaio/hadolint
|
||||
|
||||
shellcheck:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@main
|
||||
- uses: docker://kokuwaio/shellcheck
|
||||
26
.justfile
Normal file
26
.justfile
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
# https://just.systems/man/en/
|
||||
|
||||
[private]
|
||||
@default:
|
||||
just --list --unsorted
|
||||
|
||||
# Run linter.
|
||||
@lint:
|
||||
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/shellcheck
|
||||
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/hadolint
|
||||
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/yamllint
|
||||
docker run --rm --read-only --volume=$(pwd):$(pwd):rw --workdir=$(pwd) kokuwaio/markdownlint --fix
|
||||
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) kokuwaio/renovate
|
||||
docker run --rm --read-only --volume=$(pwd):$(pwd):ro --workdir=$(pwd) woodpeckerci/woodpecker-cli lint
|
||||
|
||||
# Build image with local docker daemon.
|
||||
@build:
|
||||
docker build . --tag=kokuwaio/buildctl:dev --load
|
||||
|
||||
# Inspect image with docker.
|
||||
@inspect: build
|
||||
docker image inspect kokuwaio/buildctl:dev
|
||||
|
||||
# Inspect image layers with `dive`.
|
||||
@dive: build
|
||||
docker run --rm -it --volume=/var/run/docker.sock:/var/run/docker.sock:ro wagoodman/dive:latest kokuwaio/buildctl:dev
|
||||
9
.markdownlint.yaml
Normal file
9
.markdownlint.yaml
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
# Default state for all rules
|
||||
default: true
|
||||
|
||||
# MD009 - Trailing spaces
|
||||
MD009:
|
||||
strict: true
|
||||
|
||||
# MD013 - Line length
|
||||
MD013: false
|
||||
56
.woodpecker/build.yaml
Normal file
56
.woodpecker/build.yaml
Normal file
|
|
@ -0,0 +1,56 @@
|
|||
when:
|
||||
instance: ci.kokuwa.io
|
||||
repo: woodpecker/buildctl
|
||||
event: [manual, push, pull_request]
|
||||
branch: main
|
||||
path: [.woodpecker/build.yaml, Dockerfile, Dockerfile.dockerignore, entrypoint.sh]
|
||||
|
||||
steps:
|
||||
|
||||
build:
|
||||
image: kokuwaio/buildctl
|
||||
settings: &settings
|
||||
name: registry.kokuwa.io/kokuwaio/buildctl:ci-${CI_PIPELINE_NUMBER}
|
||||
auth:
|
||||
registry.kokuwa.io:
|
||||
username: {from_secret: kokuwa_io_username}
|
||||
password: {from_secret: kokuwa_io_password}
|
||||
platform: [linux/amd64, linux/arm64]
|
||||
annotation:
|
||||
org.opencontainers.image.title: Buildctl WoodpeckerCI Plugin
|
||||
org.opencontainers.image.description: A WoodpeckerCI plugin for buildctl to build container images using a remote builtkitd instance.
|
||||
org.opencontainers.image.url: $CI_REPO_URL
|
||||
org.opencontainers.image.documentation: $CI_REPO_URL/README.md
|
||||
org.opencontainers.image.source: $CI_REPO_CLONE_URL
|
||||
org.opencontainers.image.revision: $CI_COMMIT_SHA
|
||||
org.opencontainers.image.vendor: kokuwa.io
|
||||
org.opencontainers.image.licenses: EUPL-1.2
|
||||
org.opencontainers.image.ref.name: kokuwaio/buildctl
|
||||
org.opencontainers.image.version: v0.23.1
|
||||
when:
|
||||
event: pull_request
|
||||
|
||||
push:
|
||||
image: kokuwaio/buildctl
|
||||
settings:
|
||||
<<: *settings
|
||||
name:
|
||||
- registry.kokuwa.io/kokuwaio/buildctl:latest
|
||||
- registry.kokuwa.io/kokuwaio/buildctl:v0.23.1
|
||||
- docker.io/kokuwaio/buildctl:latest
|
||||
- docker.io/kokuwaio/buildctl:v0.23.1
|
||||
- ghcr.io/kokuwaio/buildctl:latest
|
||||
- ghcr.io/kokuwaio/buildctl:v0.23.1
|
||||
auth:
|
||||
"https://index.docker.io/v1/":
|
||||
username: {from_secret: docker_io_username}
|
||||
password: {from_secret: docker_io_password}
|
||||
ghcr.io:
|
||||
username: {from_secret: ghcr_io_username}
|
||||
password: {from_secret: ghcr_io_password}
|
||||
registry.kokuwa.io:
|
||||
username: {from_secret: kokuwa_io_username}
|
||||
password: {from_secret: kokuwa_io_password}
|
||||
when:
|
||||
event: [manual, push]
|
||||
branch: main
|
||||
17
.woodpecker/dockerhub.yaml
Normal file
17
.woodpecker/dockerhub.yaml
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
when:
|
||||
instance: ci.kokuwa.io
|
||||
repo: woodpecker/buildctl
|
||||
event: [manual, push]
|
||||
branch: main
|
||||
path: [.woodpecker/dockerhub.yaml, README.md]
|
||||
|
||||
steps:
|
||||
|
||||
metadata:
|
||||
image: kokuwaio/dockerhub-metadata
|
||||
settings:
|
||||
repository: kokuwaio/buildctl
|
||||
description-short: A WoodpeckerCI plugin for buildctl to build container images using a remote builtkitd instance.
|
||||
categories: [developer-tools, integration-and-delivery]
|
||||
username: {from_secret: dockerhub_username}
|
||||
password: {from_secret: dockerhub_password}
|
||||
31
.woodpecker/lint.yaml
Normal file
31
.woodpecker/lint.yaml
Normal file
|
|
@ -0,0 +1,31 @@
|
|||
when:
|
||||
event: [manual, push, pull_request]
|
||||
branch: main
|
||||
path: [.woodpecker/lint.yaml, renovate.json, "**/*.yaml", "**/*.md", "**/*.sh", "**/Dockerfile"]
|
||||
|
||||
steps:
|
||||
|
||||
renovate:
|
||||
image: kokuwaio/renovate-config-validator
|
||||
depends_on: []
|
||||
when: [path: [.woodpecker/lint.yaml, renovate.json]]
|
||||
|
||||
yaml:
|
||||
image: kokuwaio/yamllint
|
||||
depends_on: []
|
||||
when: [path: [.woodpecker/lint.yaml, .yamllint.yaml, "**/*.yaml"]]
|
||||
|
||||
markdown:
|
||||
image: kokuwaio/markdownlint
|
||||
depends_on: []
|
||||
when: [path: [.woodpecker/lint.yaml, .markdownlint.yaml, "**/*.md"]]
|
||||
|
||||
dockerfile:
|
||||
image: kokuwaio/hadolint
|
||||
depends_on: []
|
||||
when: [path: [.woodpecker/lint.yaml, "**/Dockerfile"]]
|
||||
|
||||
shellcheck:
|
||||
image: kokuwaio/shellcheck
|
||||
depends_on: []
|
||||
when: [path: [.woodpecker/lint.yaml, "**/*.sh"]]
|
||||
36
.woodpecker/test.yaml
Normal file
36
.woodpecker/test.yaml
Normal file
|
|
@ -0,0 +1,36 @@
|
|||
when:
|
||||
instance: ci.kokuwa.io
|
||||
repo: woodpecker/buildctl
|
||||
event: [manual, push, pull_request]
|
||||
branch: main
|
||||
path: [.woodpecker/build.yaml, Dockerfile, Dockerfile.dockerignore, entrypoint.sh]
|
||||
|
||||
depends_on: [build]
|
||||
matrix:
|
||||
PLATFORM: [amd64, arm64]
|
||||
labels:
|
||||
platform: linux/${PLATFORM}
|
||||
|
||||
steps:
|
||||
|
||||
pr:
|
||||
image: registry.kokuwa.io/kokuwaio/buildctl:ci-${CI_PIPELINE_NUMBER}
|
||||
commands: buildctl --version
|
||||
when:
|
||||
event: pull_request
|
||||
|
||||
kokuwa.io: &version
|
||||
image: registry.kokuwa.io/kokuwaio/buildctl
|
||||
pull: true
|
||||
commands: buildctl --version
|
||||
when:
|
||||
event: [manual, push]
|
||||
branch: main
|
||||
|
||||
docker.io:
|
||||
image: docker.io/kokuwaio/buildctl
|
||||
<<: *version
|
||||
|
||||
ghcr.io:
|
||||
image: ghcr.io/kokuwaio/buildctl
|
||||
<<: *version
|
||||
19
.yamllint.yaml
Normal file
19
.yamllint.yaml
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
extends: default
|
||||
|
||||
## see https://yamllint.readthedocs.io/en/stable/rules.html
|
||||
rules:
|
||||
|
||||
# no need for document start
|
||||
document-start: disable
|
||||
|
||||
# line length is not important
|
||||
line-length: disable
|
||||
|
||||
# force double quotes everywhere
|
||||
quoted-strings:
|
||||
quote-type: double
|
||||
required: only-when-needed
|
||||
|
||||
# allow everything on keys
|
||||
truthy:
|
||||
check-keys: false
|
||||
28
Dockerfile
Normal file
28
Dockerfile
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
# ignore pipefail because
|
||||
# bash is non-default location https://github.com/tianon/docker-bash/issues/29
|
||||
# hadolint only uses default locations https://github.com/hadolint/hadolint/issues/977
|
||||
# hadolint global ignore=DL4006
|
||||
|
||||
FROM docker.io/library/bash:5.2.37@sha256:01a15c6f48f6a3c08431cd77e11567823530b18159889dca3b7309b707beef91
|
||||
SHELL ["/usr/local/bin/bash", "-u", "-e", "-o", "pipefail", "-c"]
|
||||
|
||||
RUN ARCH=$(uname -m) && \
|
||||
[[ $ARCH == x86_64 ]] && export SUFFIX=amd64; \
|
||||
[[ $ARCH == aarch64 ]] && export SUFFIX=arm64; \
|
||||
[[ -z ${SUFFIX:-} ]] && echo "Unknown arch: $ARCH" && exit 1; \
|
||||
wget -q "https://github.com/jqlang/jq/releases/download/jq-1.8.0/jq-linux-$SUFFIX" --output-document=/usr/local/bin/jq && \
|
||||
chmod 555 /usr/local/bin/jq
|
||||
|
||||
RUN ARCH=$(uname -m) && \
|
||||
[[ $ARCH == x86_64 ]] && export SUFFIX=amd64; \
|
||||
[[ $ARCH == aarch64 ]] && export SUFFIX=arm64; \
|
||||
[[ -z ${SUFFIX:-} ]] && echo "Unknown arch: $ARCH" && exit 1; \
|
||||
wget -q "https://github.com/moby/buildkit/releases/download/v0.23.1/buildkit-v0.23.1.linux-$SUFFIX.tar.gz" --output-document=- | tar --gz --extract --directory=/usr/local bin/buildctl && \
|
||||
chmod 555 /usr/local/bin/buildctl
|
||||
|
||||
COPY --chmod=555 entrypoint.sh /usr/local/bin/entrypoint.sh
|
||||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
|
||||
|
||||
RUN mkdir -p /home/buildkit/.docker/ && echo '{}' > /home/buildkit/.docker/config.json && chown 1000:1000 /home/buildkit -R
|
||||
ENV HOME=/home/buildkit
|
||||
USER 1000:1000
|
||||
3
Dockerfile.dockerignore
Normal file
3
Dockerfile.dockerignore
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
.*
|
||||
|
||||
!entrypoint.sh
|
||||
288
LICENSE
Normal file
288
LICENSE
Normal file
|
|
@ -0,0 +1,288 @@
|
|||
|
||||
EUROPEAN UNION PUBLIC LICENCE v. 1.2
|
||||
EUPL © the European Union 2007, 2016
|
||||
|
||||
This European Union Public Licence (the 'EUPL') applies to the Work (as defined
|
||||
below) which is provided under the terms of this Licence. Any use of the Work,
|
||||
other than as authorised under this Licence is prohibited (to the extent such
|
||||
use is covered by a right of the copyright holder of the Work).
|
||||
|
||||
The Work is provided under the terms of this Licence when the Licensor (as
|
||||
defined below) has placed the following notice immediately following the
|
||||
copyright notice for the Work:
|
||||
|
||||
Licensed under the EUPL
|
||||
|
||||
or has expressed by any other means his willingness to license under the EUPL.
|
||||
|
||||
1. Definitions
|
||||
|
||||
In this Licence, the following terms have the following meaning:
|
||||
|
||||
- 'The Licence': this Licence.
|
||||
|
||||
- 'The Original Work': the work or software distributed or communicated by the
|
||||
Licensor under this Licence, available as Source Code and also as Executable
|
||||
Code as the case may be.
|
||||
|
||||
- 'Derivative Works': the works or software that could be created by the
|
||||
Licensee, based upon the Original Work or modifications thereof. This Licence
|
||||
does not define the extent of modification or dependence on the Original Work
|
||||
required in order to classify a work as a Derivative Work; this extent is
|
||||
determined by copyright law applicable in the country mentioned in Article 15.
|
||||
|
||||
- 'The Work': the Original Work or its Derivative Works.
|
||||
|
||||
- 'The Source Code': the human-readable form of the Work which is the most
|
||||
convenient for people to study and modify.
|
||||
|
||||
- 'The Executable Code': any code which has generally been compiled and which is
|
||||
meant to be interpreted by a computer as a program.
|
||||
|
||||
- 'The Licensor': the natural or legal person that distributes or communicates
|
||||
the Work under the Licence.
|
||||
|
||||
- 'Contributor(s)': any natural or legal person who modifies the Work under the
|
||||
Licence, or otherwise contributes to the creation of a Derivative Work.
|
||||
|
||||
- 'The Licensee' or 'You': any natural or legal person who makes any usage of
|
||||
the Work under the terms of the Licence.
|
||||
|
||||
- 'Distribution' or 'Communication': any act of selling, giving, lending,
|
||||
renting, distributing, communicating, transmitting, or otherwise making
|
||||
available, online or offline, copies of the Work or providing access to its
|
||||
essential functionalities at the disposal of any other natural or legal
|
||||
person.
|
||||
|
||||
2. Scope of the rights granted by the Licence
|
||||
|
||||
The Licensor hereby grants You a worldwide, royalty-free, non-exclusive,
|
||||
sublicensable licence to do the following, for the duration of copyright vested
|
||||
in the Original Work:
|
||||
|
||||
- use the Work in any circumstance and for all usage,
|
||||
- reproduce the Work,
|
||||
- modify the Work, and make Derivative Works based upon the Work,
|
||||
- communicate to the public, including the right to make available or display
|
||||
the Work or copies thereof to the public and perform publicly, as the case may
|
||||
be, the Work,
|
||||
- distribute the Work or copies thereof,
|
||||
- lend and rent the Work or copies thereof,
|
||||
- sublicense rights in the Work or copies thereof.
|
||||
|
||||
Those rights can be exercised on any media, supports and formats, whether now
|
||||
known or later invented, as far as the applicable law permits so.
|
||||
|
||||
In the countries where moral rights apply, the Licensor waives his right to
|
||||
exercise his moral right to the extent allowed by law in order to make effective
|
||||
the licence of the economic rights here above listed.
|
||||
|
||||
The Licensor grants to the Licensee royalty-free, non-exclusive usage rights to
|
||||
any patents held by the Licensor, to the extent necessary to make use of the
|
||||
rights granted on the Work under this Licence.
|
||||
|
||||
3. Communication of the Source Code
|
||||
|
||||
The Licensor may provide the Work either in its Source Code form, or as
|
||||
Executable Code. If the Work is provided as Executable Code, the Licensor
|
||||
provides in addition a machine-readable copy of the Source Code of the Work
|
||||
along with each copy of the Work that the Licensor distributes or indicates, in
|
||||
a notice following the copyright notice attached to the Work, a repository where
|
||||
the Source Code is easily and freely accessible for as long as the Licensor
|
||||
continues to distribute or communicate the Work.
|
||||
|
||||
4. Limitations on copyright
|
||||
|
||||
Nothing in this Licence is intended to deprive the Licensee of the benefits from
|
||||
any exception or limitation to the exclusive rights of the rights owners in the
|
||||
Work, of the exhaustion of those rights or of other applicable limitations
|
||||
thereto.
|
||||
|
||||
5. Obligations of the Licensee
|
||||
|
||||
The grant of the rights mentioned above is subject to some restrictions and
|
||||
obligations imposed on the Licensee. Those obligations are the following:
|
||||
|
||||
Attribution right: The Licensee shall keep intact all copyright, patent or
|
||||
trademarks notices and all notices that refer to the Licence and to the
|
||||
disclaimer of warranties. The Licensee must include a copy of such notices and a
|
||||
copy of the Licence with every copy of the Work he/she distributes or
|
||||
communicates. The Licensee must cause any Derivative Work to carry prominent
|
||||
notices stating that the Work has been modified and the date of modification.
|
||||
|
||||
Copyleft clause: If the Licensee distributes or communicates copies of the
|
||||
Original Works or Derivative Works, this Distribution or Communication will be
|
||||
done under the terms of this Licence or of a later version of this Licence
|
||||
unless the Original Work is expressly distributed only under this version of the
|
||||
Licence — for example by communicating 'EUPL v. 1.2 only'. The Licensee
|
||||
(becoming Licensor) cannot offer or impose any additional terms or conditions on
|
||||
the Work or Derivative Work that alter or restrict the terms of the Licence.
|
||||
|
||||
Compatibility clause: If the Licensee Distributes or Communicates Derivative
|
||||
Works or copies thereof based upon both the Work and another work licensed under
|
||||
a Compatible Licence, this Distribution or Communication can be done under the
|
||||
terms of this Compatible Licence. For the sake of this clause, 'Compatible
|
||||
Licence' refers to the licences listed in the appendix attached to this Licence.
|
||||
Should the Licensee's obligations under the Compatible Licence conflict with
|
||||
his/her obligations under this Licence, the obligations of the Compatible
|
||||
Licence shall prevail.
|
||||
|
||||
Provision of Source Code: When distributing or communicating copies of the Work,
|
||||
the Licensee will provide a machine-readable copy of the Source Code or indicate
|
||||
a repository where this Source will be easily and freely available for as long
|
||||
as the Licensee continues to distribute or communicate the Work.
|
||||
|
||||
Legal Protection: This Licence does not grant permission to use the trade names,
|
||||
trademarks, service marks, or names of the Licensor, except as required for
|
||||
reasonable and customary use in describing the origin of the Work and
|
||||
reproducing the content of the copyright notice.
|
||||
|
||||
6. Chain of Authorship
|
||||
|
||||
The original Licensor warrants that the copyright in the Original Work granted
|
||||
hereunder is owned by him/her or licensed to him/her and that he/she has the
|
||||
power and authority to grant the Licence.
|
||||
|
||||
Each Contributor warrants that the copyright in the modifications he/she brings
|
||||
to the Work are owned by him/her or licensed to him/her and that he/she has the
|
||||
power and authority to grant the Licence.
|
||||
|
||||
Each time You accept the Licence, the original Licensor and subsequent
|
||||
Contributors grant You a licence to their contributions to the Work, under the
|
||||
terms of this Licence.
|
||||
|
||||
7. Disclaimer of Warranty
|
||||
|
||||
The Work is a work in progress, which is continuously improved by numerous
|
||||
Contributors. It is not a finished work and may therefore contain defects or
|
||||
'bugs' inherent to this type of development.
|
||||
|
||||
For the above reason, the Work is provided under the Licence on an 'as is' basis
|
||||
and without warranties of any kind concerning the Work, including without
|
||||
limitation merchantability, fitness for a particular purpose, absence of defects
|
||||
or errors, accuracy, non-infringement of intellectual property rights other than
|
||||
copyright as stated in Article 6 of this Licence.
|
||||
|
||||
This disclaimer of warranty is an essential part of the Licence and a condition
|
||||
for the grant of any rights to the Work.
|
||||
|
||||
8. Disclaimer of Liability
|
||||
|
||||
Except in the cases of wilful misconduct or damages directly caused to natural
|
||||
persons, the Licensor will in no event be liable for any direct or indirect,
|
||||
material or moral, damages of any kind, arising out of the Licence or of the use
|
||||
of the Work, including without limitation, damages for loss of goodwill, work
|
||||
stoppage, computer failure or malfunction, loss of data or any commercial
|
||||
damage, even if the Licensor has been advised of the possibility of such damage.
|
||||
However, the Licensor will be liable under statutory product liability laws as
|
||||
far such laws apply to the Work.
|
||||
|
||||
9. Additional agreements
|
||||
|
||||
While distributing the Work, You may choose to conclude an additional agreement,
|
||||
defining obligations or services consistent with this Licence. However, if
|
||||
accepting obligations, You may act only on your own behalf and on your sole
|
||||
responsibility, not on behalf of the original Licensor or any other Contributor,
|
||||
and only if You agree to indemnify, defend, and hold each Contributor harmless
|
||||
for any liability incurred by, or claims asserted against such Contributor by
|
||||
the fact You have accepted any warranty or additional liability.
|
||||
|
||||
10. Acceptance of the Licence
|
||||
|
||||
The provisions of this Licence can be accepted by clicking on an icon 'I agree'
|
||||
placed under the bottom of a window displaying the text of this Licence or by
|
||||
affirming consent in any other similar way, in accordance with the rules of
|
||||
applicable law. Clicking on that icon indicates your clear and irrevocable
|
||||
acceptance of this Licence and all of its terms and conditions.
|
||||
|
||||
Similarly, you irrevocably accept this Licence and all of its terms and
|
||||
conditions by exercising any rights granted to You by Article 2 of this Licence,
|
||||
such as the use of the Work, the creation by You of a Derivative Work or the
|
||||
Distribution or Communication by You of the Work or copies thereof.
|
||||
|
||||
11. Information to the public
|
||||
|
||||
In case of any Distribution or Communication of the Work by means of electronic
|
||||
communication by You (for example, by offering to download the Work from a
|
||||
remote location) the distribution channel or media (for example, a website) must
|
||||
at least provide to the public the information requested by the applicable law
|
||||
regarding the Licensor, the Licence and the way it may be accessible, concluded,
|
||||
stored and reproduced by the Licensee.
|
||||
|
||||
12. Termination of the Licence
|
||||
|
||||
The Licence and the rights granted hereunder will terminate automatically upon
|
||||
any breach by the Licensee of the terms of the Licence.
|
||||
|
||||
Such a termination will not terminate the licences of any person who has
|
||||
received the Work from the Licensee under the Licence, provided such persons
|
||||
remain in full compliance with the Licence.
|
||||
|
||||
13. Miscellaneous
|
||||
|
||||
Without prejudice of Article 9 above, the Licence represents the complete
|
||||
agreement between the Parties as to the Work.
|
||||
|
||||
If any provision of the Licence is invalid or unenforceable under applicable
|
||||
law, this will not affect the validity or enforceability of the Licence as a
|
||||
whole. Such provision will be construed or reformed so as necessary to make it
|
||||
valid and enforceable.
|
||||
|
||||
The European Commission may publish other linguistic versions or new versions of
|
||||
this Licence or updated versions of the Appendix, so far this is required and
|
||||
reasonable, without reducing the scope of the rights granted by the Licence. New
|
||||
versions of the Licence will be published with a unique version number.
|
||||
|
||||
All linguistic versions of this Licence, approved by the European Commission,
|
||||
have identical value. Parties can take advantage of the linguistic version of
|
||||
their choice.
|
||||
|
||||
14. Jurisdiction
|
||||
|
||||
Without prejudice to specific agreement between parties,
|
||||
|
||||
- any litigation resulting from the interpretation of this License, arising
|
||||
between the European Union institutions, bodies, offices or agencies, as a
|
||||
Licensor, and any Licensee, will be subject to the jurisdiction of the Court
|
||||
of Justice of the European Union, as laid down in article 272 of the Treaty on
|
||||
the Functioning of the European Union,
|
||||
|
||||
- any litigation arising between other parties and resulting from the
|
||||
interpretation of this License, will be subject to the exclusive jurisdiction
|
||||
of the competent court where the Licensor resides or conducts its primary
|
||||
business.
|
||||
|
||||
15. Applicable Law
|
||||
|
||||
Without prejudice to specific agreement between parties,
|
||||
|
||||
- this Licence shall be governed by the law of the European Union Member State
|
||||
where the Licensor has his seat, resides or has his registered office,
|
||||
|
||||
- this licence shall be governed by Belgian law if the Licensor has no seat,
|
||||
residence or registered office inside a European Union Member State.
|
||||
|
||||
Appendix
|
||||
|
||||
'Compatible Licences' according to Article 5 EUPL are:
|
||||
|
||||
- GNU General Public License (GPL) v. 2, v. 3
|
||||
- GNU Affero General Public License (AGPL) v. 3
|
||||
- Open Software License (OSL) v. 2.1, v. 3.0
|
||||
- Eclipse Public License (EPL) v. 1.0
|
||||
- CeCILL v. 2.0, v. 2.1
|
||||
- Mozilla Public Licence (MPL) v. 2
|
||||
- GNU Lesser General Public Licence (LGPL) v. 2.1, v. 3
|
||||
- Creative Commons Attribution-ShareAlike v. 3.0 Unported (CC BY-SA 3.0) for
|
||||
works other than software
|
||||
- European Union Public Licence (EUPL) v. 1.1, v. 1.2
|
||||
- Québec Free and Open-Source Licence — Reciprocity (LiLiQ-R) or Strong
|
||||
Reciprocity (LiLiQ-R+).
|
||||
|
||||
The European Commission may update this Appendix to later versions of the above
|
||||
licences without producing a new version of the EUPL, as long as they provide
|
||||
the rights granted in Article 2 of this Licence and protect the covered Source
|
||||
Code from exclusive appropriation.
|
||||
|
||||
All other changes or additions to this Appendix require the production of a new
|
||||
EUPL version.
|
||||
99
README.md
Normal file
99
README.md
Normal file
|
|
@ -0,0 +1,99 @@
|
|||
# Buildctl WoodpeckerCI Plugin
|
||||
|
||||
[](https://hub.docker.com/r/kokuwaio/buildctl)
|
||||
[](https://hub.docker.com/r/kokuwaio/buildctl)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/src/branch/main/Dockerfile)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/src/branch/main/LICENSE)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/pulls)
|
||||
[](https://git.kokuwa.io/woodpecker/buildctl/issues)
|
||||
|
||||
A [WoodpeckerCI](https://woodpecker-ci.org) plugin for [buildctl](https://github.com/moby/buildkit) to build container images using a remote buildkit host.
|
||||
Also usable with Gitlab, Github or locally, see examples for usage.
|
||||
|
||||
## Features
|
||||
|
||||
- preconfigured for [reproduceable builds](https://github.com/moby/buildkit/blob/master/docs/build-repro.md)
|
||||
- attestations not yet supported because of [github.com/moby/buildkit/issues/3552](https://github.com/moby/buildkit/issues/3552)
|
||||
- runnable with local buildkit daemon
|
||||
|
||||
## Example
|
||||
|
||||
WoodpeckerCI:
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
buildctl:
|
||||
image: kokuwaio/buildctl
|
||||
settings:
|
||||
name:
|
||||
- registry.example.org/foo:latest
|
||||
- registry.example.org/foo:0.0.1
|
||||
annotation:
|
||||
org.opencontainers.image.title: My Image
|
||||
org.opencontainers.image.description: A description.
|
||||
build-args:
|
||||
NPM_CONFIG_REGISTRY: ${NPM_CONFIG_REGISTRY} # reused from ci env
|
||||
FOO: bar
|
||||
platform: [linux/amd64, linux/arm64]
|
||||
auth:
|
||||
registry.example.org:
|
||||
username: {from_secret: my_username}
|
||||
password: {from_secret: my_password}
|
||||
https://index.docker.io/v1/":
|
||||
username: {from_secret: docker_io_username}
|
||||
password: {from_secret: docker_io_password}
|
||||
|
||||
```
|
||||
|
||||
Gitlab:
|
||||
|
||||
```yaml
|
||||
buildctl:
|
||||
stage: lint
|
||||
image: kokuwaio/buildctl
|
||||
variables:
|
||||
PLUGIN_ADDR: tcp://0.8.1.5:1234
|
||||
PLUGIN_NAME: registry.example.org/foo:latest,registry.example.org/foo:0.0.1
|
||||
PLUGIN_PLATFORM: linux/amd64,linux/arm64
|
||||
PLUGIN_AUTH: '{"registry.example.org":{"username":"my-user","password":"changeMe"}}'
|
||||
rules:
|
||||
- if: $CI_PIPELINE_SOURCE == "merge_request_event"
|
||||
changes: [.buildctl.yaml, "**/*.y*ml"]
|
||||
```
|
||||
|
||||
CLI (will reuse docker credentials of current user):
|
||||
|
||||
```bash
|
||||
PLUGIN_ADDR=tcp://0.8.1.5:1234
|
||||
PLUGIN_NAME=registry.example.org/foo:latest,registry.example.org/foo:0.0.1
|
||||
PLUGIN_PLATFORM=linux/amd64,linux/arm64
|
||||
docker run --rm --user=$(id -u) --volume=$HOME:$HOME:ro --workdir=$PWD --env=PLUGIN_ADDR --env=PLUGIN_NAME --env=PLUGIN_PLATFORM kokuwaio/buildctl
|
||||
```
|
||||
|
||||
## Settings
|
||||
|
||||
| Settings Name | Environment | Default | Description |
|
||||
| ------------------- | ------------------------ | ---------------- | ----------------------------------------------------------------------------------------------- |
|
||||
| `addr` | PLUGIN_ADDR | `$BUILDKIT_HOST` | Buildkit host to use. |
|
||||
| `frontend` | PLUGIN_FRONTEND | `dockerfile.v0` | Only dockerfile frontend supported right now |
|
||||
| `context` | PLUGIN_CONTEXT | `$PWD` | Context directory to use for build |
|
||||
| `dockerfile` | PLUGIN_DOCKERFILE | `Dockerfile` | Dockerfile to use. |
|
||||
| `target` | PLUGIN_TARGET | `none` | Dockerfile target |
|
||||
| `build-args` | PLUGIN_BUILD_ARGS | `none` | Build args to pass to build |
|
||||
| `platform` | PLUGIN_PLATFORM | `none` | Target platform for container image. |
|
||||
| `source-epoch-date` | PLUGIN_SOURCE_DATE_EPOCH | `0` | Timestamp to use for reproduceable builds. |
|
||||
| `name` | PLUGIN_NAME | `none` | Images names where to push the image. |
|
||||
| `annotation` | PLUGIN_ANNOTATION | `none` | Annotations (also known as labels) to add to image |
|
||||
| `push` | PLUGIN_PUSH | `true` | Push images if output names are set. |
|
||||
| `auth` | PLUGIN_AUTH | `none` | Auth for private registries |
|
||||
| `env-file` | PLUGIN_ENV_FILE | `none` | Source environment values from given file |
|
||||
|
||||
## Alternatives
|
||||
|
||||
| Image | Comment | amd64 | arm64 |
|
||||
| --------------------------------------------------------------- | --------------------------------- |:-----:|:-----:|
|
||||
| [kokuwaio/buildctl](https://hub.docker.com/r/kokuwaio/buildctl) | Woodpecker plugin | [](https://hub.docker.com/r/kokuwaio/buildctl) | [](https://hub.docker.com/r/kokuwaio/buildctl) |
|
||||
| [moby/buildkit](https://hub.docker.com/r/moby/buildkit) | not a Woodpecker plugin | [](https://hub.docker.com/r/moby/buildkit) | [](https://hub.docker.com/r/moby/buildkit) |
|
||||
| [nordseth/buildctl](https://hub.docker.com/r/nordseth/buildctl) | not a Woodpecker plugin | [](https://hub.docker.com/r/nordseth/buildctl) | [](https://hub.docker.com/r/nordseth/buildctl) |
|
||||
| [shopstic/buildctl](https://hub.docker.com/r/shopstic/buildctl) | not a Woodpecker plugin, outdated | [](https://hub.docker.com/r/shopstic/buildctl) | [](https://hub.docker.com/r/shopstic/buildctl) |
|
||||
| [agisoft/buildctl](https://hub.docker.com/r/agisoft/buildctl) | not a Woodpecker plugin, outdated | [](https://hub.docker.com/r/agisoft/buildctl) | [](https://hub.docker.com/r/agisoft/buildctl) |
|
||||
102
entrypoint.sh
Executable file
102
entrypoint.sh
Executable file
|
|
@ -0,0 +1,102 @@
|
|||
#!/usr/bin/env bash
|
||||
set -eu;
|
||||
|
||||
##
|
||||
## check input
|
||||
##
|
||||
|
||||
if [[ -n "${PLUGIN_ENV_FILE:-}" ]]; then
|
||||
if [[ ! -f "$PLUGIN_ENV_FILE" ]]; then
|
||||
echo "Env file $PLUGIN_ENV_FILE not found."
|
||||
exit 1
|
||||
fi
|
||||
# shellcheck source=/dev/null
|
||||
source "$PLUGIN_ENV_FILE"
|
||||
fi
|
||||
|
||||
BUILDCTL_CONTEXT=${PLUGIN_CONTEXT:-$(pwd)}
|
||||
BUILDCTL_DOCKERFILE=$(dirname "${PLUGIN_DOCKERFILE:-$BUILDCTL_CONTEXT/Dockerfile}")
|
||||
if [[ ! -f $BUILDCTL_DOCKERFILE/Dockerfile ]]; then
|
||||
echo "Dockerfile $BUILDCTL_DOCKERFILE/Dockerfile not found!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
BUILDCTL_FRONTEND=${PLUGIN_FRONTEND:-dockerfile.v0}
|
||||
if [[ "$BUILDCTL_FRONTEND" != "dockerfile.v0" ]]; then
|
||||
echo "Only frontend 'dockerfile.v0' tested and supported yet."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
SOURCE_DATE_EPOCH=${PLUGIN_SOURCE_DATE_EPOCH:-0}
|
||||
|
||||
if [[ -n "${PLUGIN_AUTH:-}" ]]; then
|
||||
echo "$PLUGIN_AUTH" | jq -r 'to_entries|map({(.key):{"auth":(.value.username+":"+.value.password)|@base64}})|add|{"auths":.}' > "$HOME/.docker/config.json"
|
||||
echo "Stored credentials at $HOME/.docker/config.json"
|
||||
echo
|
||||
fi
|
||||
|
||||
##
|
||||
## build command
|
||||
##
|
||||
|
||||
COMMAND="buildctl build"
|
||||
if [[ -n "${PLUGIN_ADDR:-}" ]]; then
|
||||
COMMAND+=" --addr=$PLUGIN_ADDR"
|
||||
fi
|
||||
COMMAND+=" --frontend=$BUILDCTL_FRONTEND"
|
||||
COMMAND+=" --local=context=$BUILDCTL_CONTEXT"
|
||||
COMMAND+=" --local=dockerfile=$BUILDCTL_DOCKERFILE"
|
||||
if [[ -n "${PLUGIN_PLATFORM:-}" ]]; then
|
||||
COMMAND+=" --opt=platform=$PLUGIN_PLATFORM"
|
||||
fi
|
||||
if [[ -n "${PLUGIN_TARGET:-}" ]]; then
|
||||
COMMAND+=" --opt=target=$PLUGIN_TARGET"
|
||||
fi
|
||||
if [[ -n "${PLUGIN_BUILD_ARGS:-}" ]]; then
|
||||
COMMAND+="$(eval "echo \"${PLUGIN_BUILD_ARGS//\"/\\\"}\"" | jq --join-output 'keys[] as $k|" --opt=build-arg:\($k)=\(.[$k])"')"
|
||||
fi
|
||||
COMMAND+=" --opt=build-arg:SOURCE_DATE_EPOCH=$SOURCE_DATE_EPOCH"
|
||||
|
||||
# https://github.com/moby/buildkit/blob/master/README.md#output
|
||||
if [[ -n "${PLUGIN_NAME:-}" ]]; then
|
||||
PLUGIN_NAME="$(eval "echo \"${PLUGIN_NAME//\"/\\\"}\"")"
|
||||
OUTPUT="type=image"
|
||||
if [[ "$PLUGIN_NAME" =~ .*,.* ]]; then
|
||||
# https://github.com/moby/buildkit/issues/797#issuecomment-1561601104
|
||||
OUTPUT+=",\"name=$PLUGIN_NAME\""
|
||||
else
|
||||
OUTPUT+=",name=$PLUGIN_NAME"
|
||||
fi
|
||||
if [[ -n "${PLUGIN_ANNOTATION:-}" ]]; then
|
||||
OUTPUT+="$(eval "echo \"${PLUGIN_ANNOTATION//\"/\\\"}\"" | jq --join-output 'keys[] as $k|",annotation.\($k)=\(.[$k])"')"
|
||||
fi
|
||||
OUTPUT+=",push=${PLUGIN_PUSH:-true},oci-mediatypes=true,compression=estargz,compression-level=9,rewrite-timestamp=true"
|
||||
COMMAND+=" --output='$OUTPUT'"
|
||||
fi
|
||||
|
||||
##
|
||||
## execute command
|
||||
##
|
||||
|
||||
echo
|
||||
echo Reproduce with docker:
|
||||
echo
|
||||
echo " docker buildx build ${PLUGIN_CONTEXT:-.} \\"
|
||||
if [[ -n "${PLUGIN_TARGET:-}" ]]; then
|
||||
echo " --target=$PLUGIN_TARGET \\"
|
||||
fi
|
||||
echo " --no-cache \\"
|
||||
echo " --provenance=false \\"
|
||||
echo " --build-arg=SOURCE_DATE_EPOCH=$SOURCE_DATE_EPOCH \\"
|
||||
if [[ -n "${PLUGIN_PLATFORM:-}" ]]; then
|
||||
echo " --platform=$PLUGIN_PLATFORM \\"
|
||||
fi
|
||||
if [[ -n "${OUTPUT:-}" ]]; then
|
||||
echo " --output='${OUTPUT//push=true/push=false}'"
|
||||
fi
|
||||
echo
|
||||
echo Running now:
|
||||
echo
|
||||
echo -e " ${COMMAND// --/ \\n --}"
|
||||
echo
|
||||
eval "$COMMAND"
|
||||
27
renovate.json
Normal file
27
renovate.json
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": ["local>infrastructure/renovate-config", ":reviewer(stephan.schnabel)"],
|
||||
"customManagers": [
|
||||
{
|
||||
"customType": "regex",
|
||||
"managerFilePatterns": ["Dockerfile", ".woodpecker/build.yaml"],
|
||||
"matchStrings": [
|
||||
"- registry.kokuwa.io/kokuwaio/buildctl:(?<currentValue>v[0-9]+\\.[0-9]+\\.[0-9]+)",
|
||||
"- docker.io/kokuwaio/buildctl:(?<currentValue>v[0-9]+\\.[0-9]+\\.[0-9]+)",
|
||||
"- ghcr.io/kokuwaio/buildctl:(?<currentValue>v[0-9]+\\.[0-9]+\\.[0-9]+)",
|
||||
"org.opencontainers.image.version: (?<currentValue>v[0-9]+\\.[0-9]+\\.[0-9]+)",
|
||||
"github.com/moby/buildkit/releases/download/(?<currentValue>v[0-9]+\\.[0-9]+\\.[0-9]+)/buildkit-v[0-9]+\\.[0-9]+\\.[0-9]+.linux-\\$SUFFIX.tar.gz",
|
||||
"github.com/moby/buildkit/releases/download/v[0-9]+\\.[0-9]+\\.[0-9]+/buildkit-(?<currentValue>v[0-9]+\\.[0-9]+\\.[0-9]+).linux-\\$SUFFIX.tar.gz"
|
||||
],
|
||||
"datasourceTemplate": "github-releases",
|
||||
"packageNameTemplate": "moby/buildkit"
|
||||
},{
|
||||
"customType": "regex",
|
||||
"managerFilePatterns": ["Dockerfile"],
|
||||
"matchStrings": ["github.com/jqlang/jq/releases/download/(?<currentValue>jq-[0-9]+\\.[0-9]+\\.[0-9]+)/jq-linux-\\$SUFFIX"],
|
||||
"datasourceTemplate": "github-releases",
|
||||
"packageNameTemplate": "jqlang/jq",
|
||||
"versioningTemplate": "regex:^jq-?(?<major>[0-9]+)\\.(?<minor>[0-9]+)\\.(?<patch>[0-9]+)?$"
|
||||
}
|
||||
]
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue