Merge pull request #234 from nanos/container-tags

Tag container images with stable, and with major and minor versions

Author: nanos

.github/workflows/update-version-number.yaml

@@ -53,13 +53,31 @@ jobs:
           registry: ghcr.io
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
+      - name: Work out the image tags
+        id: tags
+        env:
+          REF: ${{ github.ref_name }}
+          IMAGE: ghcr.io/${{ github.repository_owner }}/fedifetcher
+        run: |
+          {
+            echo "tags<<EOF"
+            echo "$IMAGE:$REF"
+            echo "$IMAGE:latest"
+            # Only an unsuffixed vX.Y.Z tag is a stable release; v8.1.0-rc1 is not.
+            # Pre-releases must not move the major and minor tags: someone pinned
+            # to v8 is asking for 8.x patches, not for a release candidate.
+            if [[ "$REF" =~ ^v([0-9]+)\.([0-9]+)\.[0-9]+$ ]]; then
+              echo "$IMAGE:stable"
+              echo "$IMAGE:v${BASH_REMATCH[1]}"
+              echo "$IMAGE:v${BASH_REMATCH[1]}.${BASH_REMATCH[2]}"
+            fi
+            echo "EOF"
+          } >> "$GITHUB_OUTPUT"
       - name: Build and push
         id: docker_build
         uses: docker/build-push-action@v7
         with:
           context: .
           push: true
           platforms: linux/amd64,linux/arm64
-          tags: |
-            ghcr.io/${{ github.repository_owner }}/fedifetcher:${{ github.ref_name }}
-            ghcr.io/${{ github.repository_owner }}/fedifetcher:latest
+          tags: ${{ steps.tags.outputs.tags }}

examples/docker-compose.yaml

@@ -3,7 +3,10 @@ services:
   fedifetcher:
     stdin_open: true
     tty: true
-    image: ghcr.io/nanos/fedifetcher:latest
+    # `stable` is the latest stable release. Other tags, including pinning to a
+    # major or minor version, are described at
+    # https://github.com/nanos/FediFetcher/wiki/Running-FediFetcher-from-a-container#choosing-a-tag
+    image: ghcr.io/nanos/fedifetcher:stable
     # We override the Dockerfile entrypoint, run the python code with our commands, then append our sleep command: resume after a minute.
     entrypoint: ["sh", "-c", "python /app/find_posts.py; sleep 60; "]
     environment:

examples/k8s-cronjob.md

@@ -46,7 +46,7 @@ spec:
           restartPolicy: Never
           containers:
             - name: fedifetcher
-              image: ghcr.io/nanos/fedifetcher:latest
+              image: ghcr.io/nanos/fedifetcher:stable
               imagePullPolicy: IfNotPresent
               env:
                 - name: FF_HOME_TIMELINE_LENGTH
@@ -82,3 +82,9 @@ spec:
                 claimName: fedifetcher-pvc
 ```
 
+`stable` is the latest stable release. Other tags, including pinning to a major or minor version, are described in [Running FediFetcher from a container](https://github.com/nanos/FediFetcher/wiki/Running-FediFetcher-from-a-container#choosing-a-tag).
+
+> [!NOTE]
+>
+> `imagePullPolicy: IfNotPresent` will not pick up a new image when a floating tag such as `stable` moves. Use `Always`, or pin to a version tag, if you want updates.
+