feat: standardize versioning across OSTree and os-release

antheas · antheas · commit 7652b5e3e451 · 2024-07-31T18:30:54.000+03:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -61,6 +61,7 @@ jobs:
         fedora_version: [40]
         include:
           - fedora_version: 40
+            bazzite_version: "v3.6"
             is_latest_version: true
             is_stable_version: true
             kernel_flavor: fsync # must match a kernel_flavor from akmods repo
@@ -133,64 +134,6 @@ jobs:
       - name: Maximize build space
         uses: ublue-os/remove-unwanted-software@v7
 
-      - name: Generate tags
-        id: generate-tags
-        shell: bash
-        run: |
-          # Generate a timestamp for creating an image version history
-          TIMESTAMP="$(date +%Y%m%d)"
-          FEDORA_VERSION="${{ matrix.fedora_version }}"
-          COMMIT_TAGS=()
-          BUILD_TAGS=()
-          # Have tags for tracking builds during pull request
-          SHA_SHORT="${GITHUB_SHA::7}"
-          COMMIT_TAGS+=("pr-${{ github.event.pull_request.number }}-${FEDORA_VERSION}")
-          COMMIT_TAGS+=("${SHA_SHORT}-${FEDORA_VERSION}")
-          if [[ "${{ matrix.is_latest_version }}" == "true" ]] && \
-             [[ "${{ matrix.is_stable_version }}" == "true" ]]; then
-              COMMIT_TAGS+=("pr-${{ github.event.pull_request.number }}")
-              COMMIT_TAGS+=("${SHA_SHORT}")
-          fi
-
-          if [[ ${{ github.ref_name }} == "unstable" ]]; then
-             BUILD_TAGS=("${FEDORA_VERSION}-unstable" "${FEDORA_VERSION}-unstable-${TIMESTAMP}")
-             if [[ "${{ matrix.is_latest_version }}" == "true" ]] && \
-                [[ "${{ matrix.is_stable_version }}" == "true" ]]; then
-                 BUILD_TAGS+=("unstable")
-                 echo "DEFAULT_TAG=unstable" >> $GITHUB_ENV
-             fi
-          elif [[ ${{ github.ref_name }} == "testing" ]]; then
-             BUILD_TAGS=("${FEDORA_VERSION}-testing" "${FEDORA_VERSION}-testing-${TIMESTAMP}")
-             if [[ "${{ matrix.is_latest_version }}" == "true" ]] && \
-                [[ "${{ matrix.is_stable_version }}" == "true" ]]; then
-                 BUILD_TAGS+=("testing")
-                 echo "DEFAULT_TAG=testing" >> $GITHUB_ENV
-             fi
-          else
-             BUILD_TAGS=("${FEDORA_VERSION}" "${FEDORA_VERSION}-${TIMESTAMP}")
-             BUILD_TAGS+=("${FEDORA_VERSION}-stable" "${FEDORA_VERSION}-stable-${TIMESTAMP}")
-             if [[ "${{ matrix.is_latest_version }}" == "true" ]] && \
-                [[ "${{ matrix.is_stable_version }}" == "true" ]]; then
-                 BUILD_TAGS+=("latest" "stable")
-                 echo "DEFAULT_TAG=latest" >> $GITHUB_ENV
-             fi
-          fi
-
-          if [[ "${{ github.event_name }}" == "pull_request" ]]; then
-              echo "Generated the following commit tags: "
-              for TAG in "${COMMIT_TAGS[@]}"; do
-                  echo "${TAG}"
-              done
-              alias_tags=("${COMMIT_TAGS[@]}")
-          else
-              alias_tags=("${BUILD_TAGS[@]}")
-          fi
-          echo "Generated the following build tags: "
-          for TAG in "${BUILD_TAGS[@]}"; do
-              echo "${TAG}"
-          done
-          echo "alias_tags=${alias_tags[*]}" >> $GITHUB_OUTPUT
-
       - name: Pull main, akmods, rechunk images
         uses: Wandalen/wretry.action@v3.5.0
         with:
@@ -229,6 +172,38 @@ jobs:
               exit 1
             fi
             echo "KERNEL_VERSION=$linux" >> $GITHUB_ENV
+      
+      # Generate a primary version key that appears
+      # in KDE, rpm-ostree status, and github.
+      - name: Generate Version
+        id: generate-version
+        shell: bash
+        run: |
+          # Generate the primary version key that will be stored on os-release,
+          # shown on the bootloader, and used for the image tag.
+          UPSTREAM_TAG="${{ env.SOURCE_IMAGE_VERSION }}"
+          FEDORA_VERSION="${{ matrix.fedora_version }}"
+          BAZZITE_VERSION="${{ matrix.bazzite_version }}"
+          SHA_SHORT="${GITHUB_SHA::7}"
+
+          if [ -n "${{ github.event.pull_request.number }}" ]; then
+            VERSION="pr-${FEDORA_VERSION}-${{ github.event.pull_request.number }}"
+            PRETTY_VERSION="PR (${{ github.event.pull_request.number }}, ${UPSTREAM_TAG})"
+          elif [[ ${{ github.ref_name }} == "unstable" ]]; then
+            VERSION="unstable-${SHA_SHORT}"
+            PRETTY_VERSION="Unstable (#${SHA_SHORT}, F${UPSTREAM_TAG})"
+          elif [[ ${{ github.ref_name }} == "testing" ]]; then
+            VERSION="testing-${BAZZITE_VERSION}-${UPSTREAM_TAG}"
+            PRETTY_VERSION="Testing (${BAZZITE_VERSION}, F${UPSTREAM_TAG})"
+          else
+            VERSION="${BAZZITE_VERSION}-${UPSTREAM_TAG}"
+            PRETTY_VERSION="Stable (${BAZZITE_VERSION}, F${UPSTREAM_TAG})"
+          fi
+          echo "tag=${VERSION}" >> $GITHUB_OUTPUT
+          echo "pretty=${PRETTY_VERSION}" >> $GITHUB_OUTPUT
+
+          echo "Generated the following:"
+          cat $GITHUB_OUTPUT
 
       # Build image using buildah and save it to raw-img
       - name: Build Image
@@ -245,6 +220,8 @@ jobs:
             --build-arg KERNEL_FLAVOR=${{ matrix.kernel_flavor }} \
             --build-arg IMAGE_BRANCH=${{ github.ref_name }} \
             --build-arg SHA_HEAD_SHORT=${{ env.SHA_HEAD_SHORT }} \
+            --build-arg VERSION_TAG=${{ steps.generate-version.outputs.tag }} \
+            --build-arg VERSION_PRETTY="${{ steps.generate-version.outputs.pretty }}" \
             --tag raw-img .
       
       - name: Remove auxiliary images
@@ -265,7 +242,7 @@ jobs:
           # to avoid layer shifts.
           # prev-ref: ${{ github.event.inputs.fresh-rechunk == 'true' && '' || 'ghcr.io/ublue-os/bazzite:unstable' }}
           rechunk: 'ghcr.io/hhd-dev/rechunk:v0.1.8'
-          version: '${{ env.SOURCE_IMAGE_VERSION }}'
+          version: '${{ steps.generate-version.outputs.tag }}'
           labels: |
             io.artifacthub.package.logo-url=https://raw.githubusercontent.com/ublue-os/bazzite/main/repo_content/logo.png
             io.artifacthub.package.readme-url=https://bazzite.gg/
@@ -276,6 +253,76 @@ jobs:
             org.opencontainers.image.source=https://github.com/ublue-os/bazzite
             org.opencontainers.image.title=bazzite
             org.opencontainers.image.url=https://github.com/ublue-os/bazzite
+      
+      # Generate tags after rechunker runs and checks the primary tag is not duplicated
+      # If it is, rechunk will suffix it by .1, .2, etc and put it in steps.rechunk.outputs.version
+      - name: Generate tags
+        id: generate-tags
+        shell: bash
+        run: |
+          # Common vars for generating tags
+          VERSION_TAG="${{ steps.rechunk.outputs.version }}"
+          UPSTREAM_TAG="${{ env.SOURCE_IMAGE_VERSION }}"
+          FEDORA_VERSION="${{ matrix.fedora_version }}"
+          BAZZITE_VERSION="${{ matrix.bazzite_version }}"
+          SHA_SHORT="${GITHUB_SHA::7}"
+          BUILD_TAGS=( "${VERSION_TAG}" )
+
+          # Use latest var to check if we should tag as latest
+          unset LATEST
+          if [[ "${{ matrix.is_latest_version }}" == "true" ]] && \
+              [[ "${{ matrix.is_stable_version }}" == "true" ]]; then
+                LATEST="1"
+          fi
+
+          if [[ "${{ github.event_name }}" == "pull_request" ]]; then
+            # Track latest ver per PR
+            if [ -n "$LATEST" ]; then
+                BUILD_TAGS+=("pr-${{ github.event.pull_request.number }}")
+            fi
+          elif [[ ${{ github.ref_name }} == "unstable" ]]; then
+            # Per fedora version
+            BUILD_TAGS+=("${FEDORA_VERSION}-unstable")
+            BUILD_TAGS+=("unstable-${FEDORA_VERSION}") # flip ver to be last
+
+            # Per upstream ver
+            BUILD_TAGS+=("unstable-${UPSTREAM_TAG}")
+
+            if [ -n "$LATEST" ]; then
+                BUILD_TAGS+=("unstable")
+            fi
+          elif [[ ${{ github.ref_name }} == "testing" ]]; then
+            # Per fedora version
+            BUILD_TAGS+=("${FEDORA_VERSION}-testing")
+            BUILD_TAGS+=("testing-${FEDORA_VERSION}") # flip ver to be last
+
+            # Per upstream ver
+            BUILD_TAGS+=("testing-${UPSTREAM_TAG}")
+
+            if [ -n "$LATEST" ]; then
+                BUILD_TAGS+=("testing-${BAZZITE_VERSION}")
+                BUILD_TAGS+=("testing")
+            fi
+          else
+            BUILD_TAGS+=("${FEDORA_VERSION}")
+            BUILD_TAGS+=("${UPSTREAM_TAG}")
+            BUILD_TAGS+=("${BAZZITE_VERSION}")
+            BUILD_TAGS+=("stable-${UPSTREAM_TAG}")
+
+            # Per fedora version
+            BUILD_TAGS+=("${FEDORA_VERSION}-stable")
+            BUILD_TAGS+=("stable-${FEDORA_VERSION}") # flip ver to be last
+            
+            if [ -n "$LATEST" ]; then
+              BUILD_TAGS+=("latest" "stable")
+            fi
+          fi
+          
+          echo "Generated the following build tags: "
+          for TAG in "${BUILD_TAGS[@]}"; do
+              echo "${TAG}"
+          done
+          echo "alias_tags=${BUILD_TAGS[*]}" >> $GITHUB_OUTPUT
 
       # Pull oci-dir image, remove oci dir to make space, and then tag appropriately
       - name: Load in podman and tag
diff --git a/Containerfile b/Containerfile
@@ -8,6 +8,8 @@ ARG BASE_IMAGE="ghcr.io/ublue-os/${SOURCE_IMAGE}"
 ARG FEDORA_MAJOR_VERSION="${FEDORA_MAJOR_VERSION:-40}"
 ARG JUPITER_KERNEL_VERSION="${JUPITER_KERNEL_VERSION:-jupiter-20240605.1}"
 ARG SHA_HEAD_SHORT="${SHA_HEAD_SHORT}"
+ARG VERSION_TAG="${VERSION_TAG}"
+ARG VERSION_PRETTY="${VERSION_PRETTY}"
 
 FROM ghcr.io/ublue-os/akmods:${KERNEL_FLAVOR}-${FEDORA_MAJOR_VERSION} AS akmods
 FROM ghcr.io/ublue-os/akmods-extra:${KERNEL_FLAVOR}-${FEDORA_MAJOR_VERSION} AS akmods-extra
@@ -24,6 +26,8 @@ ARG BASE_IMAGE_NAME="${BASE_IMAGE_NAME:-kinoite}"
 ARG FEDORA_MAJOR_VERSION="${FEDORA_MAJOR_VERSION:-40}"
 ARG JUPITER_KERNEL_VERSION="${JUPITER_KERNEL_VERSION:-jupiter-20240605.1}"
 ARG SHA_HEAD_SHORT="${SHA_HEAD_SHORT}"
+ARG VERSION_TAG="${VERSION_TAG}"
+ARG VERSION_PRETTY="${VERSION_PRETTY}"
 
 COPY system_files/desktop/shared system_files/desktop/${BASE_IMAGE_NAME} /
 
@@ -692,6 +696,8 @@ ARG KERNEL_FLAVOR="${KERNEL_FLAVOR:-fsync}"
 ARG IMAGE_BRANCH="${IMAGE_BRANCH:-main}"
 ARG BASE_IMAGE_NAME="${BASE_IMAGE_NAME:-kinoite}"
 ARG FEDORA_MAJOR_VERSION="${FEDORA_MAJOR_VERSION:-40}"
+ARG VERSION_TAG="${VERSION_TAG}"
+ARG VERSION_PRETTY="${VERSION_PRETTY}"
 
 COPY system_files/deck/shared system_files/deck/${BASE_IMAGE_NAME} /
 
@@ -841,6 +847,8 @@ ARG KERNEL_FLAVOR="${KERNEL_FLAVOR:-fsync}"
 ARG IMAGE_BRANCH="${IMAGE_BRANCH:-main}"
 ARG BASE_IMAGE_NAME="${BASE_IMAGE_NAME:-kinoite}"
 ARG FEDORA_MAJOR_VERSION="${FEDORA_MAJOR_VERSION:-40}"
+ARG VERSION_TAG="${VERSION_TAG}"
+ARG VERSION_PRETTY="${VERSION_PRETTY}"
 
 # Fetch NVIDIA driver
 COPY system_files/nvidia/shared system_files/nvidia/${BASE_IMAGE_NAME} /
diff --git a/system_files/desktop/shared/usr/libexec/containerbuild/image-info b/system_files/desktop/shared/usr/libexec/containerbuild/image-info
@@ -38,7 +38,9 @@ cat > $IMAGE_INFO <<EOF
   "image-tag": "$IMAGE_TAG",
   "image-branch": "$IMAGE_BRANCH_NORMALIZED",
   "base-image-name": "$BASE_IMAGE_NAME",
-  "fedora-version": "$FEDORA_MAJOR_VERSION"
+  "fedora-version": "$FEDORA_MAJOR_VERSION",
+  "version": "$VERSION_TAG",
+  "version-pretty": "$VERSION_PRETTY"
 }
 EOF
 
@@ -62,5 +64,8 @@ if [[ -n "${SHA_HEAD_SHORT:-}" ]]; then
   echo "BUILD_ID=\"$SHA_HEAD_SHORT\"" >> /usr/lib/os-release
 fi
 
+# FIXME: Pretty name needs to have deck/KDE/GNOME/etc
+echo "BOOTLOADER_NAME=\"$IMAGE_PRETTY_NAME $VERSION_PRETTY\"" >> /usr/lib/os-release
+
 # Fix issues caused by ID no longer being fedora
 sed -i "s/^EFIDIR=.*/EFIDIR=\"fedora\"/" /usr/sbin/grub2-switch-to-blscfg
