ci(package): add labels to container image (#54)

Also enable build triggered by event eodag_release.

Signed-off-by: Aubin Lambaré <aubin.lambare@cs-soprasteria.com>

Author: alambare

.github/workflows/package.yml

@@ -1,10 +1,12 @@
-name: Create and publish a Docker image
+name: Build and publish a container image
 
 on:
   push:
     branches: ['main']
     tags: ['v*']
   workflow_dispatch:
+  repository_dispatch:
+    types: [eodag_release]
 
 env:
   REGISTRY: ghcr.io
@@ -13,42 +15,68 @@ env:
 jobs:
   build-and-push-image:
     runs-on: ubuntu-latest
-    # Sets the permissions granted to the GITHUB_TOKEN for the actions in this job.
     permissions:
       contents: read
       packages: write
-      attestations: write
       id-token: write
 
-    # Uses the docker/login-action action to log in to the Container registry
-    # using the account and password that will publish the packages. Once published,
-    # the packages are scoped to the account defined here.
     steps:
       - name: Checkout repository
         uses: actions/checkout@v5
 
+      - name: Install uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install dependencies
+        run: uv sync --with server --with telemetry
+
+      - name: Determine the container tag and labels
+        id: container_tag
+        run: |
+          APP_VERSION=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml'))['project']['version'])")
+          echo "APP_VERSION=$APP_VERSION" >> $GITHUB_ENV
+
+          EODAG_VERSION=$(PYTHONWARNINGS="ignore::SyntaxWarning" uv run --active python -c "import eodag; print(eodag.__version__)")
+          echo "EODAG_VERSION=$EODAG_VERSION" >> $GITHUB_ENV
+
+          # Default: branch name
+          CONTAINER_TAG=${GITHUB_REF##*/}
+
+          # Check if this is a release or eodag dispatch
+          if [[ "${GITHUB_REF_TYPE}" == "tag" || ( "${GITHUB_EVENT_NAME}" == "repository_dispatch" && "${GITHUB_EVENT_CLIENT_PAYLOAD_TYPE}" == "eodag_release" ) ]]; then
+              CONTAINER_TAG="${APP_VERSION}-eodag-${EODAG_VERSION}"
+          fi
+
+          echo "CONTAINER_TAG=$CONTAINER_TAG" >> $GITHUB_ENV
+
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      - name: Log in to the Container registry
+      - name: Log in to the container registry
         uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
-      # This step uses docker/metadata-action to extract tags and labels that will be applied to the
-      # specified image. The id "meta" allows the output of this step to be referenced in a subsequent step.
-      - name: Extract metadata (tags, labels) for Docker
+      - name: Extract container metadata
         id: meta
         uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+          tags: |
+            custom=stac-fastapi-eodag:${{ env.CONTAINER_TAG }}
+          labels: |
+            org.opencontainers.image.title=stac-fastapi-eodag
+            org.opencontainers.image.description=A STAC FastAPI backend using EODAG
+            org.opencontainers.image.url=https://github.com/CS-SI/stac-fastapi-eodag
+            org.opencontainers.image.source=https://github.com/CS-SI/stac-fastapi-eodag.git
+            org.opencontainers.image.licenses=Apache-2.0
+            org.opencontainers.image.authors=CS GROUP - France (CSSI) <eodag@csgroup.space>
+            org.opencontainers.image.version=${{ env.APP_VERSION }}
+            org.opencontainers.image.eodag.version=${{ env.EODAG_VERSION }}
 
-      # Use the docker/build-push-action action to build the image based on Dockerfile. If the build succeeds,
-      # it pushes the image to GitHub Packages. It uses the tags and labels parameters to tag and label the image
-      # with the output from the "meta" step.
-      - name: Build and push Docker image
+      - name: Build and push container image
         id: push
         uses: docker/build-push-action@v6
         with:

.gitignore

@@ -51,6 +51,7 @@ wheels/
 *.egg-info/
 .installed.cfg
 *.egg
+uv.lock
 
 # PyInstaller
 #  Usually these files are written by a python script from a template