change NSC package name, add badges creation & deploy

Author: AnastaZIuk

.github/workflows/build-nabla.yml

@@ -5,6 +5,9 @@ on:
   pull_request:
   workflow_dispatch:
 
+permissions:
+  contents: read
+
 concurrency:
   group: push-lock-${{ github.ref }}
   cancel-in-progress: true
@@ -54,10 +57,10 @@ jobs:
         shell: pwsh
         run: |
           $prefix = "run-windows-${{ matrix.tag }}-${{ matrix.vendor }}-${{ matrix.config }}"
-          $repo = $env:GITHUB_REPOSITORY
-          $tag = "nsc-godbolt-build-${{ matrix.vendor }}-${{ matrix.config }}-${{ matrix.tag }}"
-          $nscTargetTaggedImage = "ghcr.io/${repo}:${tag}".ToLower()
-          $nscTargetTaggedImageLatest = "ghcr.io/${repo}:nsc-godbolt-latest".ToLower()
+          $package = "nabla-shader-compiler-godbolt"
+          $tag = "build-${{ matrix.vendor }}-${{ matrix.config }}-${{ matrix.tag }}"
+          $nscTargetTaggedImage = "ghcr.io/${package}:${tag}".ToLower()
+          $nscTargetTaggedImageLatest = "ghcr.io/${package}:latest".ToLower()
 
           $shouldPushImage = (
             "${{ github.ref }}" -eq "refs/heads/master" -and
@@ -178,4 +181,67 @@ jobs:
       - name: Push images to GHCR
         if: steps.set-prefix.outputs.shouldPushImage == 'True'
         run: |
-          docker push ${{ steps.set-prefix.outputs.nscTargetTaggedImageLatest }}
+          docker push ${{ steps.set-prefix.outputs.nscTargetTaggedImageLatest }}
+
+  update-badges:
+    name: Update Build & Image Badges
+    if: ${{ always() && github.ref == 'refs/heads/master' }}
+    needs: build-windows
+    runs-on: windows-2022
+    permissions:
+      contents: write
+
+    steps:
+      - name: Create Build Badge
+        run: |
+          $jobStatus = "${{ needs.build-windows.result }}"
+          $buildMsg = if ($jobStatus -eq "success") { "passing" } else { "failing" }
+          $buildColor = if ($jobStatus -eq "success") { "brightgreen" } else { "red" }
+
+          $buildBadge = @{
+            schemaVersion = 1
+            label = "build"
+            message = $buildMsg
+            color = $buildColor
+          } | ConvertTo-Json -Depth 2
+
+          $buildPath = ".badge-public/nabla"
+          New-Item -ItemType Directory -Path $buildPath -Force | Out-Null
+          $buildBadge | Set-Content -Path "$buildPath/build.json" -Encoding utf8
+
+      - name: Create Image Size Badge
+        run: |
+          $image = "ghcr.io/devsh-graphics-programming/nabla:nsc-godbolt-latest"
+          $manifest = docker manifest inspect $image | ConvertFrom-Json
+
+          if ($manifest.manifests) {
+            $totalSize = ($manifest.manifests | Measure-Object -Property size -Sum).Sum
+          } elseif ($manifest.layers) {
+            $totalSize = ($manifest.layers | Measure-Object -Property size -Sum).Sum
+          } else {
+            Write-Error "No valid size information found in manifest."
+            exit 1
+          }
+
+          $sizeMB = [Math]::Round($totalSize / 1MB, 2)
+          $size = "$sizeMB MB"
+
+          $imageBadge = @{
+            schemaVersion = 1
+            label = $image
+            message = $size
+            color = "blue"
+          } | ConvertTo-Json -Depth 2
+
+          $imagePath = ".badge-public/packages/nabla-shader-compiler-nsc"
+          New-Item -ItemType Directory -Path $imagePath -Force | Out-Null
+          $imageBadge | Set-Content -Path "$imagePath/image-badge.json" -Encoding utf8
+
+      - name: Deploy Badges
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_branch: badges
+          publish_dir: .badge-public
+          keep_files: true
+          commit_message: "[CI] badges update"

.github/workflows/run-nsc.yml

@@ -121,11 +121,11 @@ jobs:
       - name: Generate and run Docker Compose with matched image
         run: |
           $imageName = docker image ls --format "{{.Repository}}:{{.Tag}}" |
-            Where-Object { $_ -like "ghcr.io/devsh-graphics-programming/nabla:nsc-*" } |
+            Where-Object { $_ -like "ghcr.io/devsh-graphics-programming/nabla-shader-compiler-godbolt:build-*" } |
             Select-Object -First 1
 
           if (-not $imageName) {
-            Write-Error "Could not find image with tag matching ghcr.io/devsh-graphics-programming/nabla:nsc-*"
+            Write-Error "Could not find image with tag matching ghcr.io/devsh-graphics-programming/nabla-shader-compiler-godbolt:build-*"
             exit 1
           }
 

README.md

@@ -2,9 +2,15 @@
 <div align="center">
    <img alt="Click to see the source" height="200" src="nabla-glow.svg" width="200" />
 </div>
-<div align="center">
-  <img alt="Click to see the source" height="200" src="https://github.com/user-attachments/assets/81f15d9b-0b9b-4ecc-981a-6e43e3b4c49b" width="700" />
-</div>
+
+<p align="center">
+  <a href="https://github.com/Devsh-Graphics-Programming/Nabla/actions">
+    <img src="https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/Devsh-Graphics-Programming/Nabla/badges/nabla/build.json" alt="Build Status" /></a>
+  <a href="https://opensource.org/licenses/Apache-2.0">
+    <img src="https://img.shields.io/badge/license-Apache%202.0-blue" alt="License: Apache 2.0" /></a>
+  <a href="https://discord.gg/Dx83Cu7suD">
+    <img src="https://img.shields.io/discord/308323056592486420?label=discord&logo=discord&logoColor=white&color=7289DA" alt="Join our Discord" /></a>
+</p>
 
 # Table of Contents
 

compose.yml

@@ -1,7 +1,7 @@
 services:
   nsc:
     container_name: nsc-godbolt
-    image: ghcr.io/devsh-graphics-programming/nabla:nsc-godbolt-latest
+    image: ghcr.io/devsh-graphics-programming/nabla-shader-compiler-godbolt:latest
     isolation: process
     ports:
       - "80:10240"