Publish Docker image to GitHub repository.

.github/workflows/test-docker.yaml → .github/workflows/container-image.yaml

@@ -1,4 +1,4 @@
-name: Test Docker Image
+name: Container Image
 
 on:
   pull_request:
@@ -10,6 +10,10 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
+    permissions:
+      contents: read
+      packages: write
+
     steps:
       - uses: actions/checkout@v4
 
@@ -23,3 +27,17 @@ jobs:
           out=$(mktemp -d)
           docker run --volume "$out:/out" --rm ffdocs -o /out -v 1.0.*
           test "$(find "$out" -name '*.html' | wc -l)" -ge 2
+
+      - name: Push Image
+        if: github.ref_name == 'main'
+        run: |
+          set -e
+
+          echo "${{ secrets.GITHUB_TOKEN }}" \
+            | docker login ghcr.io -u "${{ github.actor }}" --password-stdin
+
+          IMAGE_ID=ghcr.io/${{ github.repository }}:latest
+
+          set -x
+          docker tag ffdocs "$IMAGE_ID"
+          docker push "$IMAGE_ID"

README.md

@@ -83,12 +83,22 @@ $ nix develop --command ./ffmpeg-filters-docs […]
 
 ### Docker
 
-A Docker image can be built with the file [`docker/Dockerfile`](./docker/Dockerfile).
+A Docker image is published to GitHub Packages:
 
 ```console
-$ docker build --tag ffdocs --file docker/Dockerfile .
+$ docker run --rm -v /tmp/ffdocs:/out ghcr.io/ayosec/ffmpeg-filters-docs --output /out
+```
+
+To run a local checkout of the repository (for example, to test changes in the implementation), replace the `/app` directory:
 
-$ docker run --volume /tmp/web:/tmp/web ffdocs --versions 7.1 --output /tmp/web
+```console
+$ docker run --rm -v /tmp/ffdocs:/out -v "$PWD:/app" ghcr.io/ayosec/ffmpeg-filters-docs --output /out
+```
+
+The image can be built locally with the file [`docker/Dockerfile`](./docker/Dockerfile):
+
+```console
+$ docker build --tag ffmpeg-filters-docs --file docker/Dockerfile .
 ```