Initial draft of plugin.
All checks were successful
All checks were successful
This commit is contained in:
parent
500978a33f
commit
29bd3aa4d7
SSH key fingerprint:
SHA256:99zuzxNGFb5/5P+E/O7ONU2qhUojUe/D8rIPTW+9Xp0
16 changed files with 735 additions and 0 deletions
13
.github/README.md
vendored
Normal file
13
.github/README.md
vendored
Normal file
|
|
@ -0,0 +1,13 @@
|
|||
# DockerHub Metadata WoodpeckerCI Plugin
|
||||
|
||||
[](https://hub.docker.com/r/kokuwaio/dockerhub-metadata)
|
||||
[](https://hub.docker.com/r/kokuwaio/dockerhub-metadata)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/src/branch/main/Dockerfile)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/src/branch/main/LICENSE)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/pulls)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/issues)
|
||||
|
||||
A [WoodpeckerCI](https://woodpecker-ci.org) plugin to write metadata to DockerHub repositories.
|
||||
Also usable with Gitlab, Github or locally, see examples for usage.
|
||||
|
||||
For more documention see: [git.kokuwa.io/woodpecker/dockerhub-metadata](https://git.kokuwa.io/woodpecker/dockerhub-metadata)
|
||||
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/dockerhub-metadata:dev --load
|
||||
|
||||
# Inspect image with docker.
|
||||
@inspect: build
|
||||
docker image inspect kokuwaio/dockerhub-metadata: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/dockerhub-metadata: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
|
||||
53
.woodpecker/build.yaml
Normal file
53
.woodpecker/build.yaml
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
when:
|
||||
instance: ci.kokuwa.io
|
||||
repo: woodpecker/dockerhub-metadata
|
||||
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/dockerhub-metadata: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: DockerHub Metadata WoodpeckerCI Plugin
|
||||
org.opencontainers.image.description: A WoodpeckerCI plugin to write metadata to DockerHub repositories.
|
||||
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/dockerhub-metadata
|
||||
org.opencontainers.image.version: latest
|
||||
when:
|
||||
event: pull_request
|
||||
|
||||
push:
|
||||
image: kokuwaio/buildctl
|
||||
settings:
|
||||
<<: *settings
|
||||
name:
|
||||
- registry.kokuwa.io/kokuwaio/dockerhub-metadata:latest
|
||||
- docker.io/kokuwaio/dockerhub-metadata:latest
|
||||
- ghcr.io/kokuwaio/dockerhub-metadata:latest
|
||||
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
|
||||
20
.woodpecker/dockerhub.yaml
Normal file
20
.woodpecker/dockerhub.yaml
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
when:
|
||||
instance: ci.kokuwa.io
|
||||
repo: woodpecker/dockerhub-metadata
|
||||
event: [manual, push]
|
||||
branch: main
|
||||
path: [.woodpecker/dockerhub.yaml, README.md, Dockerfile, Dockerfile.dockerignore, entrypoint.sh]
|
||||
|
||||
depends_on: [build]
|
||||
|
||||
steps:
|
||||
|
||||
metadata:
|
||||
image: kokuwaio/dockerhub-metadata
|
||||
pull: true
|
||||
settings:
|
||||
repository: kokuwaio/dockerhub-metadata
|
||||
description-short: A WoodpeckerCI plugin to write metadata to DockerHub repositories.
|
||||
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/dockerhub-metadata
|
||||
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/dockerhub-metadata:ci-${CI_PIPELINE_NUMBER}
|
||||
commands: curl https://hub.docker.com/v2/namespaces/kokuwaio/repositories/dockerhub-metadata/tags --silent --fail | jq
|
||||
when:
|
||||
event: pull_request
|
||||
|
||||
kokuwa.io: &version
|
||||
image: registry.kokuwa.io/kokuwaio/dockerhub-metadata
|
||||
pull: true
|
||||
commands: curl https://hub.docker.com/v2/namespaces/kokuwaio/repositories/dockerhub-metadata/tags --silent --fail | jq
|
||||
when:
|
||||
event: [manual, push]
|
||||
branch: main
|
||||
|
||||
docker.io:
|
||||
image: docker.io/kokuwaio/dockerhub-metadata
|
||||
<<: *version
|
||||
|
||||
ghcr.io:
|
||||
image: ghcr.io/kokuwaio/dockerhub-metadata
|
||||
<<: *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
|
||||
25
Dockerfile
Normal file
25
Dockerfile
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
# 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=x86_64; \
|
||||
[[ $ARCH == aarch64 ]] && export SUFFIX=aarch64; \
|
||||
[[ -z ${SUFFIX:-} ]] && echo "Unknown arch: $ARCH" && exit 1; \
|
||||
wget -q "https://github.com/stunnel/static-curl/releases/download/8.14.1/curl-linux-$SUFFIX-glibc-8.14.1.tar.xz" --output-document=- | tar --xz --extract -o --directory=/usr/local/bin curl && \
|
||||
chmod 555 /usr/local/bin/curl
|
||||
|
||||
COPY --chmod=555 entrypoint.sh /usr/local/bin/entrypoint.sh
|
||||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"]
|
||||
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.
|
||||
63
README.md
Normal file
63
README.md
Normal file
|
|
@ -0,0 +1,63 @@
|
|||
# DockerHub Metadata WoodpeckerCI Plugin
|
||||
|
||||
[](https://hub.docker.com/r/kokuwaio/dockerhub-metadata)
|
||||
[](https://hub.docker.com/r/kokuwaio/dockerhub-metadata)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/src/branch/main/Dockerfile)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/src/branch/main/LICENSE)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/pulls)
|
||||
[](https://git.kokuwa.io/woodpecker/dockerhub-metadata/issues)
|
||||
|
||||
A [WoodpeckerCI](https://woodpecker-ci.org) plugin to write metadata to DockerHub repositories.
|
||||
Also usable with Gitlab, Github or locally, see examples for usage.
|
||||
|
||||
## Features
|
||||
|
||||
- set full description in repository from local file
|
||||
- set short description in repository from settings
|
||||
- set categories for repository
|
||||
|
||||
## Example
|
||||
|
||||
Woodpecker:
|
||||
|
||||
```yaml
|
||||
steps:
|
||||
dockerhub:
|
||||
image: kokuwaio/dockerhub-metadata
|
||||
settings:
|
||||
repository: kokuwaio/example-image
|
||||
description-short: This image does that!
|
||||
categories: [developer-tools, integration-and-delivery]
|
||||
username: {from_secret: DOCKERHUB_USERNAME}
|
||||
password: {from_secret: DOCKERHUB_PASSWORD}
|
||||
when:
|
||||
event: push
|
||||
branch: main
|
||||
path: README.md
|
||||
```
|
||||
|
||||
Gitlab:
|
||||
|
||||
```yaml
|
||||
dockerhub:
|
||||
stage: deploy
|
||||
image: kokuwaio/hadolint
|
||||
variables:
|
||||
PLUGIN_REPOSITORY: kokuwaio/example-image
|
||||
PLUGIN_DESCRIPTION_SHORT: This image does that!
|
||||
PLUGIN_CATEGORIES: developer-tools,integration-and-delivery
|
||||
rules:
|
||||
- if: $CI_PIPELINE_SOURCE == "push"
|
||||
changes: [README.md]
|
||||
```
|
||||
|
||||
## Settings
|
||||
|
||||
| Settings Name | Environment | Default | Description |
|
||||
| ------------------- | ------------------------ | ----------- | ----------------------------------------------------------- |
|
||||
| `repository` | PLUGIN_REPOSITORY | `none` | Repository to update with metadata, e.g. `kokuwaio/example` |
|
||||
| `description-short` | PLUGIN_DESCRIPTION_SHORT | `none` | Short description for repository. |
|
||||
| `description-file` | PLUGIN_DESCRIPTION_FILE | `README.md` | File to read full description from |
|
||||
| `categories` | PLUGIN_CATEGORIES | `[]` | List of categories to set (maximum 3) |
|
||||
| `username` | PLUGIN_USERNAME | `none` | Username for Dockerhub login |
|
||||
| `password` | PLUGIN_PASSWORD | `none` | Password for Dockerhub login, **PAT** is not supported! |
|
||||
79
entrypoint.sh
Executable file
79
entrypoint.sh
Executable file
|
|
@ -0,0 +1,79 @@
|
|||
#!/usr/bin/env bash
|
||||
set -eu;
|
||||
|
||||
##
|
||||
## validate inputs
|
||||
##
|
||||
|
||||
if [[ -z "${PLUGIN_USERNAME:-}" ]]; then
|
||||
echo "Missing username."
|
||||
exit 1
|
||||
fi
|
||||
if [[ -z "${PLUGIN_PASSWORD:-}" ]]; then
|
||||
echo "Missing password."
|
||||
exit 1
|
||||
fi
|
||||
if [[ -z "${PLUGIN_REPOSITORY:-}" ]]; then
|
||||
echo "Missing repository."
|
||||
exit 1
|
||||
fi
|
||||
if [[ -z "${PLUGIN_DESCRIPTION_SHORT:-}" ]]; then
|
||||
echo "Missing description-short."
|
||||
exit 1
|
||||
fi
|
||||
PLUGIN_DESCRIPTION_FILE="${PLUGIN_DESCRIPTION_FILE:-README.md}"
|
||||
if [[ ! -f "$PLUGIN_DESCRIPTION_FILE" ]]; then
|
||||
echo "File $PLUGIN_DESCRIPTION_FILE not found."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
##
|
||||
## Login to get token
|
||||
##
|
||||
|
||||
echo '> Login'
|
||||
TOKEN=$(curl https://hub.docker.com/v2/users/login \
|
||||
--fail --silent --show-error \
|
||||
--header "Content-Type: application/json" \
|
||||
--data "{\"username\":\"$PLUGIN_USERNAME\",\"password\":\"$PLUGIN_PASSWORD\"}\"" | jq -r .token)
|
||||
TOKEN_SOURCE=$(echo "$TOKEN" | jq -R 'split(".")|.[1]|@base64d|fromjson|.source.type')
|
||||
if [[ "$TOKEN_SOURCE" == "pat" ]]; then
|
||||
echo "Updating with personal access token does not work."
|
||||
return 1
|
||||
fi
|
||||
if [[ "$TOKEN_SOURCE" != "pwd" ]]; then
|
||||
echo "Warning: Not using password but '$TOKEN_SOURCE', updating metadata may not work,"
|
||||
fi
|
||||
|
||||
##
|
||||
## Update repository
|
||||
##
|
||||
|
||||
echo '> Update categories'
|
||||
BODY="["
|
||||
if [[ -n "${PLUGIN_CATEGORIES:-}" ]]; then
|
||||
for CATEGORY in ${PLUGIN_CATEGORIES//,/ }; do
|
||||
BODY="$BODY{\"slug\":\"$CATEGORY\",\"name\":\"$CATEGORY\"},"
|
||||
done
|
||||
BODY="${BODY%?}"
|
||||
fi
|
||||
curl -XPATCH "https://hub.docker.com/v2/repositories/$PLUGIN_REPOSITORY/categories" \
|
||||
--fail --silent --show-error \
|
||||
--header "Authorization: JWT $TOKEN" \
|
||||
--header "Content-Type: application/json" \
|
||||
--data "$BODY]}"
|
||||
|
||||
echo '> Update description'
|
||||
FULL=$(cat "$PLUGIN_DESCRIPTION_FILE")
|
||||
BODY=$(jq --null-input --arg short "$PLUGIN_DESCRIPTION_SHORT" --arg full "$FULL" '{"description":$short,"full_description":$full}')
|
||||
RESPONSE=$(curl -XPATCH "https://hub.docker.com/v2/repositories/$PLUGIN_REPOSITORY" \
|
||||
--fail --silent --show-error \
|
||||
--header "Authorization: JWT $TOKEN" \
|
||||
--header "Content-Type: application/json" \
|
||||
--data "$BODY")
|
||||
|
||||
echo
|
||||
echo "Repository updated: https://hub.docker.com/r/$PLUGIN_REPOSITORY"
|
||||
echo
|
||||
echo "Repsones:"
|
||||
echo "$RESPONSE"
|
||||
20
renovate.json
Normal file
20
renovate.json
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
{
|
||||
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||
"extends": ["local>infrastructure/renovate-config", ":reviewer(stephan.schnabel)"] ,
|
||||
"customManagers": [
|
||||
{
|
||||
"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]+)?$"
|
||||
},{
|
||||
"customType": "regex",
|
||||
"managerFilePatterns": ["Dockerfile"],
|
||||
"matchStrings": ["github.com/stunnel/static-curl/releases/download/(?<currentValue>[0-9]+\\.[0-9]+\\.[0-9]+)/curl-linux-\\$SUFFIX-glibc", "glibc-(?<currentValue>[0-9]+\\.[0-9]+\\.[0-9]+).tar.xz"],
|
||||
"datasourceTemplate": "github-releases",
|
||||
"packageNameTemplate": "stunnel/static-curl"
|
||||
}
|
||||
]
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue