From 40f77eaafabc62054eeef7330f778f0fc6a2ecdc Mon Sep 17 00:00:00 2001 From: adamijak Date: Fri, 7 Apr 2023 10:30:45 +0200 Subject: [PATCH] Basic docker support (#234) --- .github/workflows/docker-image.yml | 51 ++++++++++++++++++++++++++++++ Dockerfile | 10 ++++++ README.md | 3 ++ 3 files changed, 64 insertions(+) create mode 100644 .github/workflows/docker-image.yml create mode 100644 Dockerfile diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml new file mode 100644 index 000000000..10b1da4ea --- /dev/null +++ b/.github/workflows/docker-image.yml @@ -0,0 +1,51 @@ +name: Build and Publish Docker Image + +on: + release: + types: [created] + workflow_dispatch: + +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + PLATFORMS: linux/amd64,linux/arm64 + +jobs: + build-and-publish: + runs-on: ubuntu-latest + permissions: + contents: read + packages: write + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Setup Docker buildx + uses: docker/setup-buildx-action@v2.5.0 + with: + platforms: ${{ env.PLATFORMS }} + + - name: Log into registry ${{ env.REGISTRY }} + uses: docker/login-action@v2.1.0 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + + - name: Extract Docker metadata + id: meta + uses: docker/metadata-action@v4.3.0 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + + - name: Build and push Docker image + id: build-and-push + uses: docker/build-push-action@v4.0.0 + with: + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }} + platforms: ${{ env.PLATFORMS }} + cache-from: type=gha + cache-to: type=gha,mode=max diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 000000000..cbfcee2e7 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,10 @@ +FROM rust:alpine AS build +COPY . /app +WORKDIR /app +ENV CARGO_REGISTRIES_CRATES_IO_PROTOCOL=sparse +RUN apk add --update musl-dev \ + && cargo build -p typst-cli --release + +FROM alpine:latest +WORKDIR /root/ +COPY --from=build /app/target/release/typst /bin diff --git a/README.md b/README.md index 343018b16..d22bea447 100644 --- a/README.md +++ b/README.md @@ -119,6 +119,9 @@ pacman -S typst Nix users can use the `typst` package with `nix-shell -p typst` or build and run the bleeding edge version with `nix run github:typst/typst -- --version`. +Docker users can run a prebuilt image with +`docker run -it ghcr.io/typst/typst:main`. + ## Usage Once you have installed Typst, you can use it like this: ```sh