Add org.opencontainers.image.source to Dockerfiles (#9211)

### Purpose

The OCI image spec specifies well-defined
[annotations](https://github.com/opencontainers/image-spec/blob/main/annotations.md)
that can be added to images.
Theses annotations can then be used by other tools to gather more
information of an image.

This PR adds the `org.opencontainers.image.source` to allow tools such
as [renovate](https://github.com/renovatebot/renovate) to find the
release notes of a give version.

~~I've only done this change for `Dockerfile`. Should I also add the
label to the other dockerfiles?~~
I've now added the source annotations to all `Dockerfile`s & action
workflows.

### Testing

None, change was done by following the [renovate
documentation](https://docs.renovatebot.com/modules/datasource/docker/).
This commit is contained in:
DerRockWolf 2023-11-14 06:46:14 +00:00 committed by GitHub
parent d5deede7a1
commit e988978fa1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 71 additions and 10 deletions

View File

@ -12,7 +12,6 @@ env:
BUILD_HOST: github.syncthing.net BUILD_HOST: github.syncthing.net
jobs: jobs:
docker-syncthing: docker-syncthing:
name: Build and push Docker images name: Build and push Docker images
runs-on: ubuntu-latest runs-on: ubuntu-latest
@ -52,3 +51,5 @@ jobs:
platforms: linux/amd64,linux/arm64 platforms: linux/amd64,linux/arm64
push: true push: true
tags: syncthing/${{ matrix.pkg }}:latest,syncthing/${{ matrix.pkg }}:${{ github.sha }} tags: syncthing/${{ matrix.pkg }}:latest,syncthing/${{ matrix.pkg }}:${{ github.sha }}
outputs: |
annotation.org.opencontainers.image.revision="${{ github.sha }}"

View File

@ -808,6 +808,7 @@ jobs:
tags=${{ matrix.image }}:edge tags=${{ matrix.image }}:edge
fi fi
echo "DOCKER_TAGS=$tags" >> $GITHUB_ENV echo "DOCKER_TAGS=$tags" >> $GITHUB_ENV
echo "VERSION=$version" >> $GITHUB_ENV
- name: Build and push Docker image - name: Build and push Docker image
uses: docker/build-push-action@v5 uses: docker/build-push-action@v5
@ -817,6 +818,9 @@ jobs:
platforms: linux/amd64,linux/arm64,linux/arm/7 platforms: linux/amd64,linux/arm64,linux/arm/7
push: ${{ env.DOCKER_PUSH == 'true' }} push: ${{ env.DOCKER_PUSH == 'true' }}
tags: ${{ env.DOCKER_TAGS }} tags: ${{ env.DOCKER_TAGS }}
outputs: |
annotation.org.opencontainers.image.version="${{ env.VERSION }}"
annotation.org.opencontainers.image.revision="${{ github.sha }}"
# #
# Check for known vulnerabilities in Go dependencies # Check for known vulnerabilities in Go dependencies

View File

@ -29,6 +29,14 @@ RUN if [ ! -f syncthing-linux-$TARGETARCH ] ; then \
FROM alpine FROM alpine
ARG TARGETARCH ARG TARGETARCH
LABEL org.opencontainers.image.authors="The Syncthing Project" \
org.opencontainers.image.url="https://syncthing.net" \
org.opencontainers.image.documentation="https://docs.syncthing.net" \
org.opencontainers.image.source="https://github.com/syncthing/syncthing" \
org.opencontainers.image.vendor="The Syncthing Project"
org.opencontainers.image.licenses="MPL-2.0"
org.opencontainers.image.title="Syncthing"
EXPOSE 8384 22000/tcp 22000/udp 21027/udp EXPOSE 8384 22000/tcp 22000/udp 21027/udp
VOLUME ["/var/syncthing"] VOLUME ["/var/syncthing"]

View File

@ -1,6 +1,14 @@
ARG GOVERSION=latest ARG GOVERSION=latest
FROM golang:$GOVERSION FROM golang:$GOVERSION
LABEL org.opencontainers.image.authors="The Syncthing Project" \
org.opencontainers.image.url="https://syncthing.net" \
org.opencontainers.image.documentation="https://docs.syncthing.net" \
org.opencontainers.image.source="https://github.com/syncthing/syncthing" \
org.opencontainers.image.vendor="The Syncthing Project"
org.opencontainers.image.licenses="MPL-2.0"
org.opencontainers.image.title="Syncthing Builder"
# FPM to build Debian packages # FPM to build Debian packages
RUN apt-get update && apt-get install -y --no-install-recommends \ RUN apt-get update && apt-get install -y --no-install-recommends \
locales rubygems ruby-dev build-essential git \ locales rubygems ruby-dev build-essential git \

View File

@ -1,6 +1,14 @@
FROM alpine FROM alpine
ARG TARGETARCH ARG TARGETARCH
LABEL org.opencontainers.image.authors="The Syncthing Project" \
org.opencontainers.image.url="https://syncthing.net" \
org.opencontainers.image.documentation="https://docs.syncthing.net" \
org.opencontainers.image.source="https://github.com/syncthing/syncthing" \
org.opencontainers.image.vendor="The Syncthing Project"
org.opencontainers.image.licenses="MPL-2.0"
org.opencontainers.image.title="Syncthing Crash Receiver"
EXPOSE 8080 EXPOSE 8080
COPY stcrashreceiver-linux-${TARGETARCH} /bin/stcrashreceiver COPY stcrashreceiver-linux-${TARGETARCH} /bin/stcrashreceiver

View File

@ -16,6 +16,14 @@ RUN if [ ! -f stdiscosrv-linux-$TARGETARCH ] ; then \
FROM alpine FROM alpine
ARG TARGETARCH ARG TARGETARCH
LABEL org.opencontainers.image.authors="The Syncthing Project" \
org.opencontainers.image.url="https://syncthing.net" \
org.opencontainers.image.documentation="https://docs.syncthing.net" \
org.opencontainers.image.source="https://github.com/syncthing/syncthing" \
org.opencontainers.image.vendor="The Syncthing Project"
org.opencontainers.image.licenses="MPL-2.0"
org.opencontainers.image.title="Syncthing Discovery Server"
EXPOSE 19200 8443 EXPOSE 19200 8443
VOLUME ["/var/stdiscosrv"] VOLUME ["/var/stdiscosrv"]

View File

@ -1,6 +1,14 @@
FROM alpine FROM alpine
ARG TARGETARCH ARG TARGETARCH
LABEL org.opencontainers.image.authors="The Syncthing Project" \
org.opencontainers.image.url="https://syncthing.net" \
org.opencontainers.image.documentation="https://docs.syncthing.net" \
org.opencontainers.image.source="https://github.com/syncthing/syncthing" \
org.opencontainers.image.vendor="The Syncthing Project"
org.opencontainers.image.licenses="MPL-2.0"
org.opencontainers.image.title="Syncthing Relay Pool Server"
EXPOSE 8080 EXPOSE 8080
RUN apk add --no-cache ca-certificates su-exec curl RUN apk add --no-cache ca-certificates su-exec curl

View File

@ -16,6 +16,14 @@ RUN if [ ! -f strelaysrv-linux-$TARGETARCH ] ; then \
FROM alpine FROM alpine
ARG TARGETARCH ARG TARGETARCH
LABEL org.opencontainers.image.authors="The Syncthing Project" \
org.opencontainers.image.url="https://syncthing.net" \
org.opencontainers.image.documentation="https://docs.syncthing.net" \
org.opencontainers.image.source="https://github.com/syncthing/syncthing" \
org.opencontainers.image.vendor="The Syncthing Project"
org.opencontainers.image.licenses="MPL-2.0"
org.opencontainers.image.title="Syncthing Relay Server"
EXPOSE 22067 22070 EXPOSE 22067 22070
VOLUME ["/var/strelaysrv"] VOLUME ["/var/strelaysrv"]

View File

@ -1,6 +1,14 @@
FROM alpine FROM alpine
ARG TARGETARCH ARG TARGETARCH
LABEL org.opencontainers.image.authors="The Syncthing Project" \
org.opencontainers.image.url="https://syncthing.net" \
org.opencontainers.image.documentation="https://docs.syncthing.net" \
org.opencontainers.image.source="https://github.com/syncthing/syncthing" \
org.opencontainers.image.vendor="The Syncthing Project"
org.opencontainers.image.licenses="MPL-2.0"
org.opencontainers.image.title="Syncthing Upgrades"
EXPOSE 8080 EXPOSE 8080
COPY stupgrades-linux-${TARGETARCH} /bin/stupgrades COPY stupgrades-linux-${TARGETARCH} /bin/stupgrades