exmaple github workflow to build

[tcurdt]

I think it could be very helpful to have an example workflow that uses Github actions and xcaddy to build caddy ...and a container image.

[JuTemp]

I'm writing related documents, but I encountered a problem. The downloaded dependencies cannot be cached.
Here are the relevant files:

,github/workflows/caddy.yml:

on: 
  - push

permissions:
  contents: read
  packages: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v5

      - uses: actions/setup-go@v5
        with:
          # https://hub.docker.com/_/golang
          go-version: stable
          check-latest: true

      - uses: docker/login-action@v3
        with:
          registry: ghcr.io
          username: ${{ github.actor }}
          password: ${{ secrets.GITHUB_TOKEN }}
      
      - run: |
          DATE=$(date +'%Y%m%d%H%M%S')
          SHA=$(git rev-parse --short HEAD)
          echo "TAG=${DATE}-${SHA}" >> $GITHUB_ENV

      - uses: docker/build-push-action@v6
        with:
          context: .
          push: true
          tags: |
            ghcr.io/username/caddy:latest
            ghcr.io/username/caddy:${{ env.TAG }}

./Dockerfile:

FROM caddy:builder AS builder

COPY ./caddy-plugin /app/caddy-plugin

RUN xcaddy build --with example.com/custom-plugin=/app/caddy-plugin/custom-plugin

FROM caddy

COPY --from=builder /usr/bin/caddy /usr/bin/caddy

[0jaspahwa]

Is anyone still working on this? @JuTemp mentioned writing docs last August, happy to step back if so.

If it's free, I'd like to pick it up. The workflow above works, but it downloads all of Caddy's dependencies again on every run. xcaddy build runs inside a Docker stage, so the Go module cache goes away with the layer, and the caching from actions/setup-go never reaches it. I'd like to write an example that fixes that.

Two questions before I start:

1. Where should this go? README, a file under docs/, or a runnable example in .github/workflows/?
2. Should the example build a container image too, like the original request, or just the binary?

[mohammed90]

• Where should this go? README, a file under docs/, or a runnable example in .github/workflows/?

.github/workflows/ is definitly the wrong place for an example in a project that doesn't use xcaddy itself. This repo is not a Caddy module. We're probably due to move the documentation from the main README to be under docs/.

• Should the example build a container image too, like the original request, or just the binary?

xcaddy doesn't build containers, so that seems like the wrong thing to have an example for here.