update comments for versioning scheme in workflow and readme

jakoch · Mar 11, 2024 · f7e72a6 · f7e72a6
1 parent 9a5dad9
commit f7e72a6
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 24 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -85,11 +85,11 @@ jobs:
       - name: 🔽 Setup Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      # cpp-devbox:{debian_codename}-nightly-{{date}}
-      # cpp-devbox:{debian_codename}-1.0.0
-      # cpp-devbox:{debian_codename}-1.0
-      # cpp-devbox:{debian_codename}-{{date}}-sha-{{sha}} # only on push, not when tagging
-      # cpp-devbox:{debian_codename}-latest
+      # cpp-devbox:{debian_codename}-nightly-{{date}}        # only on scheduled builds
+      # cpp-devbox:{debian_codename}-{{ version }}           # only on git tag
+      # cpp-devbox:{debian_codename}-{{ major }}.{{ minor }} # only on git tag
+      # cpp-devbox:{debian_codename}-{{date}}-sha-{{sha}}    # only on push, not when tagging
+      # cpp-devbox:{debian_codename}-latest                  # always
       - name: ✏ Setup Docker Metadata
         id: metadata-base
         uses: docker/metadata-action@v5 # https://github.com/docker/metadata-action
@@ -106,11 +106,11 @@ jobs:
             type=raw,value={{ date 'YYYYMMDD' }}-sha-{{ sha }},enabled=${{ github.event_name == 'push' }}
             type=raw,value=latest
 
-      # cpp-devbox:{debian_codename}-with-vulkansdk-nightly-{{date}}
-      # cpp-devbox:{debian_codename}-with-vulkansdk-1.0.0
-      # cpp-devbox:{debian_codename}-with-vulkansdk-1.0
-      # cpp-devbox:{debian_codename}-with-vulkansdk-{{date}}-sha-{{sha}} # only on push, not when tagging
-      # cpp-devbox:{debian_codename}-with-vulkansdk-latest
+      # cpp-devbox:{debian_codename}-with-vulkansdk-nightly-{{date}}        # only on scheduled builds
+      # cpp-devbox:{debian_codename}-with-vulkansdk-{{ version }}           # only on git tag
+      # cpp-devbox:{debian_codename}-with-vulkansdk-{{ major }}.{{ minor }} # only on git tag
+      # cpp-devbox:{debian_codename}-with-vulkansdk-{{date}}-sha-{{sha}}    # only on push, not when tagging
+      # cpp-devbox:{debian_codename}-with-vulkansdk-latest                  # always
       - name: ✏ Setup Docker Metadata
         id: metadata-base-with-vulkansdk
         uses: docker/metadata-action@v5 # https://github.com/docker/metadata-action

diff --git a/README.md b/README.md
@@ -153,33 +153,35 @@ These images are unstable because:
 
 ### Versioning Scheme for Images
 
-The container images use the following versioning schemes.
+The container images use the following versioning scheme.
 
-#### Scheduled
+#### Scheduled Builds
 
 The following container tags are created for scheduled builds:
 
-- `ghcr.io/jakoch/cpp-devbox:{DEBIAN_CODENAME}-nightly-DATE-latest`
-- `ghcr.io/jakoch/cpp-devbox:{DEBIAN_CODENAME-with-vulkansdk-nightly-DATE-latest`
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-nightly-{{date}}`
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-nightly-{{date}}`
 
 #### For git push
 
 The following container tags are created only on push, not when tagging:
 
-- `ghcr.io/jakoch/cpp-devbox:{DEBIAN_CODENAME}-latest`
-- `ghcr.io/jakoch/cpp-devbox:{DEBIAN_CODENAME}-{DATE}-sha-{SHA}`
-
-- `ghcr.io/jakoch/cpp-devbox:{DEBIAN_CODENAME}-with-vulkansdk-latest`
-- `ghcr.io/jakoch/cpp-devbox:{DEBIAN_CODENAME}-with-vulkansdk--{DATE}-sha-{SHA}`
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-{{date}}-sha-{{sha}}`
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-{{date}}-sha-{{sha}}`
 
 #### For git tag
 
 The following container tags are created for git tags:
 
-- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-1.0.0`
-- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-1.0`
-- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-latest`
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-{{ version }}`
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-{{ major }}.{{ minor }}`
+
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-{{ version }}`
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-{{ major }}.{{ minor }}`
 
-- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-1.0.0`
-- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-1.0`
+#### Latest
+
+The container tag "latest" is applied to the latest build:
+
+- `ghcr.io/jakoch/cpp-devbox:{debian_codename}-latest`
 - `ghcr.io/jakoch/cpp-devbox:{debian_codename}-with-vulkansdk-latest`