Added ability to tag releases by GitHub Version (Fixes #323)

Author: jaydrogers

.github/workflows/service_docker-build-and-publish.yml

@@ -112,6 +112,7 @@ jobs:
           DOCKER_TAG_PREFIX: ${{ inputs.tag-prefix }}
           DOCKER_REGISTRY_REPOSITORIES: ${{ inputs.registry-repositories }}
           RELEASE_TYPE: ${{ inputs.release-type }}
+          GITHUB_RELEASE_TAG: ${{ github.ref }}
 
       - name: Set REPOSITORY_BUILD_VERSION
         id: set_version

docs/content/docs/2.getting-started/2.installation.md

@@ -68,7 +68,7 @@ If you use `latest`, you will always get the latest stable version of the CLI va
 label: The Full Image Tag Standard
 ---
 ```bash
-{{registry-url}}/serversideup/php:{{release-prefix}}-{{php-version}}-{{variation-name}}-{{operating-system}}
+{{registry-url}}/serversideup/php:{{release-prefix}}-{{php-version}}-{{variation-name}}-{{operating-system}}-{{github-release-version}}
 ```
 ::
 
@@ -85,16 +85,18 @@ ghcr.io/serversideup/php:8.3-fpm-nginx
 
 ::code-panel
 ---
-label: 8.1.16 running FPM + Apache on Alpine from DockerHub
+label: PHP 8.1.16, running FPM + Apache on Alpine from DockerHub, locked into our v3.0.0 GitHub Release
 ---
 ```bash
-serversideup/php:8.1.16-fpm-apache-alpine
+serversideup/php:8.1.16-fpm-apache-alpine-v3.0.0
 ```
 ::
 
+In this example, we can lock into the `v3.0.0` release of our image. This is useful if you want to ensure there are no automatic changes that could break your CI process. [View our releases →](https://github.com/serversideup/docker-php/releases)
+
 ::code-panel
 ---
-label: Beta version (of this repository, not PHP) running PHP CLI 8.x
+label: Latest beta version (of this repository, not PHP) running PHP CLI 8.x
 ---
 ```bash
 serversideup/php:beta-8

scripts/assemble-docker-tags.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 ###################################################
-# Usage: assemble-docker-tags.sh [--variation <variation> --os <os> --patch-version <patch-version> --latest]
+# Usage: assemble-docker-tags.sh --variation <variation> --os <os> --patch-version <patch-version> [--stable-release --github-release-tag <tag>]
 ###################################################
 # This scripts dives deep into the advanced logic of assembling Docker tags for GitHub Actions.
 # If $CI is "true", it outputs the tags to GITHUB_ENV for use in subsequent steps.
@@ -104,6 +104,12 @@ add_docker_tag() {
 
     # Trim commas for a better output
     echo_color_message blue "🐳 Set tag: ${tag_name//,}  "
+
+    if [[ -n "$GITHUB_RELEASE_TAG" ]]; then
+      DOCKER_TAGS+=",$tag_name-$GITHUB_RELEASE_TAG"
+      echo_color_message blue "🐳 Set tag: ${tag_name//,}-$GITHUB_RELEASE_TAG"
+    fi
+
   done
 }
 
@@ -136,7 +142,7 @@ function is_default_variation() {
 }
 
 help_menu() {
-    echo "Usage: $0 [--variation <variation> --os <os> --patch-version <patch-version> --latest]"
+    echo "Usage: $0 --variation <variation> --os <os> --patch-version <patch-version> [--stable-release --github-release-tag <tag>]"
     echo
     echo "This script dives deep into the advanced logic of assembling Docker tags for GitHub Actions."
     echo "If \$CI is 'true', it outputs the tags to GITHUB_ENV for use in subsequent steps."
@@ -147,6 +153,7 @@ help_menu() {
     echo "  --variation <variation>         Set the PHP variation (e.g., apache, fpm)"
     echo "  --os <os>                       Set the base OS (e.g., bullseye, bookworm, alpine)"
     echo "  --patch-version <patch-version> Set the PHP patch version (e.g., 7.4.10)"
+    echo "  --github-release-tag <tag>      Set the GitHub release tag"
     echo "  --stable-release                Flag the tags for a stable release"
     echo
     echo "Environment Variables (Defaults):"
@@ -173,6 +180,10 @@ while [[ $# -gt 0 ]]; do
         PHP_BUILD_VERSION="$2"
         shift 2
         ;;
+        --github-release-tag)
+        GITHUB_RELEASE_TAG="$2"
+        shift 2
+        ;;
         --stable-release)
         RELEASE_TYPE="stable"
         shift
@@ -212,12 +223,12 @@ build_major_version="${build_patch_version%%.*}"
 build_minor_version="${build_patch_version%.*}"
 
 # Fetch version data from the PHP Versions file
-latest_global_stable_major=$(yq -o=json $PHP_VERSIONS_FILE | jq -r '[.php_versions[] | select(.major | test("-rc") | not) | .major | tonumber] | max | tostring')
-latest_global_stable_minor=$(yq -o=json $PHP_VERSIONS_FILE | jq -r --arg latest_global_stable_major "$latest_global_stable_major" '.php_versions[] | select(.major == $latest_global_stable_major) | .minor_versions | map(select(.minor | test("-rc") | not) | .minor | split(".") | .[1] | tonumber) | max | $latest_global_stable_major + "." + tostring')
-latest_minor_within_build_major=$(yq -o=json $PHP_VERSIONS_FILE | jq -r --arg build_major "$build_major_version" '.php_versions[] | select(.major == $build_major) | .minor_versions | map(select(.minor | test("-rc") | not) | .minor | split(".") | .[1] | tonumber) | max | $build_major + "." + tostring')
-latest_patch_within_build_minor=$(yq -o=json $PHP_VERSIONS_FILE | jq -r --arg build_minor "$build_minor_version" '.php_versions[] | .minor_versions[] | select(.minor == $build_minor) | .patch_versions | map( split(".") | map(tonumber) ) | max | join(".")')
-latest_patch_global=$(yq -o=json $PHP_VERSIONS_FILE | jq -r '[.php_versions[] | .minor_versions[] | select(.minor | test("-rc") | not) | .patch_versions[] | select(test("-rc") | not) | split(".") | map(tonumber) ] | max | join(".")')
-default_base_os_within_build_minor=$(yq -o=json $PHP_VERSIONS_FILE | jq -r --arg build_minor "$build_minor_version" '.php_versions[] | .minor_versions[] | select(.minor == $build_minor) | .base_os[] | select(.default == true) | .name')
+latest_global_stable_major=$(yq -o=json "$PHP_VERSIONS_FILE" | jq -r '[.php_versions[] | select(.major | test("-rc") | not) | .major | tonumber] | max | tostring')
+latest_global_stable_minor=$(yq -o=json "$PHP_VERSIONS_FILE" | jq -r --arg latest_global_stable_major "$latest_global_stable_major" '.php_versions[] | select(.major == $latest_global_stable_major) | .minor_versions | map(select(.minor | test("-rc") | not) | .minor | split(".") | .[1] | tonumber) | max | $latest_global_stable_major + "." + tostring')
+latest_minor_within_build_major=$(yq -o=json "$PHP_VERSIONS_FILE" | jq -r --arg build_major "$build_major_version" '.php_versions[] | select(.major == $build_major) | .minor_versions | map(select(.minor | test("-rc") | not) | .minor | split(".") | .[1] | tonumber) | max | $build_major + "." + tostring')
+latest_patch_within_build_minor=$(yq -o=json "$PHP_VERSIONS_FILE" | jq -r --arg build_minor "$build_minor_version" '.php_versions[] | .minor_versions[] | select(.minor == $build_minor) | .patch_versions | map( split(".") | map(tonumber) ) | max | join(".")')
+latest_patch_global=$(yq -o=json "$PHP_VERSIONS_FILE" | jq -r '[.php_versions[] | .minor_versions[] | select(.minor | test("-rc") | not) | .patch_versions[] | select(test("-rc") | not) | split(".") | map(tonumber) ] | max | join(".")')
+default_base_os_within_build_minor=$(yq -o=json "$PHP_VERSIONS_FILE" | jq -r --arg build_minor "$build_minor_version" '.php_versions[] | .minor_versions[] | select(.minor == $build_minor) | .base_os[] | select(.default == true) | .name')
 
 check_vars \
   "🚨 Missing critical build variable. Check the script logic and logs" \