From 7da1aae049dbe92acee91a81bbcafa4fad14d793 Mon Sep 17 00:00:00 2001 From: AFCMS Date: Thu, 26 Sep 2024 12:02:20 +0200 Subject: [PATCH 1/4] Improve Dockerfile - Cross-compilation support (amd64 + arm64) - Use cargo build cache - Add opencontainers labels --- .dockerignore | 4 ++++ Dockerfile | 45 +++++++++++++++++++++++++++++++++++---------- 2 files changed, 39 insertions(+), 10 deletions(-) create mode 100644 .dockerignore diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 00000000..136b3eca --- /dev/null +++ b/.dockerignore @@ -0,0 +1,4 @@ +scripts +.github +.editorconfig +.pre-commit-hooks.yaml diff --git a/Dockerfile b/Dockerfile index 9eeeaa1a..636c5835 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,20 +1,45 @@ -FROM rust:alpine as base +# syntax=docker/dockerfile:1 +FROM --platform=$BUILDPLATFORM tonistiigi/xx AS xx -COPY . /src +FROM --platform=$BUILDPLATFORM rust:1.74-alpine AS base -RUN rustup update 1.74 && rustup default 1.74 - -RUN apk update \ - && apk add \ +RUN apk update && \ + apk add \ gcc \ - g++ + g++ \ + clang -RUN cd /src && cargo build --release +COPY --from=xx / / -FROM alpine as tool +ARG TARGETPLATFORM +RUN xx-info env -COPY --from=base /src/target/release/oxipng /usr/local/bin +RUN xx-apk add \ + gcc \ + musl-dev \ + libdeflate WORKDIR /src + +COPY . . + +RUN --mount=type=cache,target=/root/.cargo/git/db \ + --mount=type=cache,target=/root/.cargo/registry/cache \ + --mount=type=cache,target=/root/.cargo/registry/index \ + xx-cargo build --release && \ + xx-verify /src/target/$(xx-cargo --print-target-triple)/release/oxipng && \ + cp /src/target/$(xx-cargo --print-target-triple)/release/oxipng /src/target/oxipng + +FROM alpine AS tool + +LABEL org.opencontainers.image.title="Oxipng" +LABEL org.opencontainers.image.description="Multithreaded PNG optimizer written in Rust" +LABEL org.opencontainers.image.authors="Joshua Holmer " +LABEL org.opencontainers.image.licenses="MIT" +LABEL org.opencontainers.image.source="https://github.com/shssoichiro/oxipng" + +COPY --from=base /src/target/oxipng /usr/local/bin + +WORKDIR /work ENTRYPOINT [ "oxipng" ] CMD [ "--help" ] From 8377e343b217e1a579d2fe3a9e9c9afa6b627dda Mon Sep 17 00:00:00 2001 From: AFCMS Date: Thu, 26 Sep 2024 12:05:02 +0200 Subject: [PATCH 2/4] Add GitHub Actions for Docker image - Enable GitHub Actions Docker build cache - Disable build cache for tags - Allow running on dispatch without cache - Push to ghcr.io on master branch and tags - Publish build provenance attestation --- .github/workflows/docker.yml | 90 ++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 .github/workflows/docker.yml diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml new file mode 100644 index 00000000..4d932aef --- /dev/null +++ b/.github/workflows/docker.yml @@ -0,0 +1,90 @@ +name: docker +on: + push: + branches: + - 'master' + tags: + - 'v*.*.*' + pull_request: + types: + - opened + - synchronize + workflow_dispatch: + inputs: + use_cache: + description: "Use build cache" + required: true + type: boolean + default: true + +env: + REGISTRY: ghcr.io + # ghrc.io/OWNER/REPO + IMAGE_NAME: ${{ github.repository }} + +jobs: + build: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + id-token: write + attestations: write + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Set up QEMU + uses: docker/setup-qemu-action@v3 + + # Workaround: https://github.com/docker/build-push-action/issues/461 + - name: Setup Docker buildx + uses: docker/setup-buildx-action@v3 + + # Login against a Docker registry except on PR + # https://github.com/docker/login-action + - name: Log into registry ${{ env.REGISTRY }} + if: github.event_name != 'pull_request' + uses: docker/login-action@v3 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + # Extract metadata (tags, labels) for Docker + # For some reason the title have to be set manually + # https://github.com/docker/metadata-action + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v5 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + labels: | + org.opencontainers.image.title=Oxipng + + # Build and push Docker image with Buildx (don't push on PR) + # Cache isn't used for tags and on workflow_dispatch if specified + # https://github.com/docker/build-push-action + - name: Build and push Docker image + id: build-and-push + uses: docker/build-push-action@v6 + with: + context: . + platforms: linux/amd64,linux/arm64 + push: ${{ github.event_name != 'pull_request' }} + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + cache-from: type=gha + cache-to: type=gha,mode=max + no-cache: ${{ (github.event_name == 'workflow_dispatch' && !inputs.use_cache) || startsWith(github.ref, 'refs/tags/') }} + + # Attest the build provenance + # TODO: enable push to registry when referrers API will be supported by ghcr.io + - name: Attest Build Provenance + if: github.event_name != 'pull_request' + uses: actions/attest-build-provenance@v1 + with: + subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + subject-digest: ${{ steps.build-and-push.outputs.digest }} + push-to-registry: false \ No newline at end of file From 91158f84e5dcbcca6570aec01921434ad9870e88 Mon Sep 17 00:00:00 2001 From: AFCMS Date: Thu, 26 Sep 2024 12:05:28 +0200 Subject: [PATCH 3/4] Add basic Docker documentation --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 165ed5ed..f30897e2 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,16 @@ trunk actions enable trunk-fmt-pre-commit [trunk]: https://docs.trunk.io +## Docker + +A Docker image is availlable at `ghcr.io/shssoichiro/oxipng` for `linux/amd64` and `linux/arm64`. + +You can use it the following way: + +```bash +docker run --rm -v $(pwd):/work ghcr.io/shssoichiro/oxipng -o 4 /work/file.png +``` + ## Library Usage Although originally intended to be used as an executable, oxipng can also be used as a library in From 13ce891952c87b4d2e9915d10e523bf1cdec9758 Mon Sep 17 00:00:00 2001 From: AFCMS Date: Thu, 26 Sep 2024 12:16:08 +0200 Subject: [PATCH 4/4] Fix title annotation for Docker image --- .github/workflows/docker.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 4d932aef..c925859a 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -62,6 +62,8 @@ jobs: images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} labels: | org.opencontainers.image.title=Oxipng + annotations: | + org.opencontainers.image.title=Oxipng # Build and push Docker image with Buildx (don't push on PR) # Cache isn't used for tags and on workflow_dispatch if specified