Add some notes

conda-incubator · Jan 8, 2025 · 714640e · 714640e
1 parent 1cf15bc
commit 714640e
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/.github/workflows/build-docker-image.yml b/.github/workflows/build-docker-image.yml
@@ -1,4 +1,8 @@
 name: Build Docker image
+# This workflow builds the conda-store-ui docker image for each
+# pull request. This will ensure that no PR is breaking the docker
+# image, which will be built and pushed to GHCR when a new release
+# is cut.
 
 on:
   pull_request:

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -178,6 +178,11 @@ jobs:
         with:
           images: |
             ${{ env.GH_CONTAINER_REGISTRY }}/${{ env.IMAGE_NAME }}
+          # ref: https://github.com/docker/metadata-action?tab=readme-ov-file#typeref
+          # create tags for:
+          #  * the GH tag (eg. 2025.1.8)
+          #  * the branch (eg. main)
+          #  * the commit sha (eg. sha-860c190)
           tags: |
             type=ref,event=tag
             type=ref,event=branch
@@ -193,6 +198,7 @@ jobs:
             ${{ steps.meta.outputs.tags }}
           push: true
           labels: ${{ steps.meta.outputs.labels }}
+          # ref https://docs.docker.com/build/ci/github-actions/cache/
           cache-from: type=gha
           cache-to: type=gha,mode=max