chore: add some encouraging comments to cr.yml

Add few comments organizing and introducing the various platform images, with a note encouraging third-parties to submit update if desired.
andyholmes · Mar 23, 2024 · 46906c4 · 46906c4
1 parent ba412ff
commit 46906c4
Showing 1 changed file with 21 additions and 5 deletions.
diff --git a/.github/workflows/cr.yml b/.github/workflows/cr.yml
@@ -28,6 +28,10 @@ jobs:
     strategy:
       matrix:
         runtime:
+          # freedesktop.org
+          #
+          # These are images for the freedesktop.org runtime, and those that
+          # add a few packages to support additional languages and so on.
           - name: freedesktop
             tag: 22.08
             packages: org.freedesktop.Platform/x86_64/22.08 org.freedesktop.Sdk/x86_64/22.08 org.freedesktop.Platform/aarch64/22.08 org.freedesktop.Sdk/aarch64/22.08
@@ -43,6 +47,19 @@ jobs:
             packages: org.freedesktop.Sdk.Extension.llvm17/x86_64/23.08 org.freedesktop.Sdk.Extension.rust-stable/x86_64/23.08 org.freedesktop.Sdk.Extension.llvm17/aarch64/23.08 org.freedesktop.Sdk.Extension.rust-stable/aarch64/23.08
             remote: flathub
 
+          # elementaryOS
+          #
+          # These are images for the elementaryOS runtime. The maintainer
+          # doesn't use these, but feel free to open a PR if out-of-date.
+          - name: elementary
+            tag: juno-22.08
+            packages: io.elementary.BaseApp//juno-22.08 org.freedesktop.Platform//22.08 org.freedesktop.Sdk//22.08
+            remote: flathub
+
+          # GNOME
+          #
+          # These are images for the GNOME runtime, and those that add a few
+          # things for e.g. Rust bindings.
           - name: gnome
             tag: 45
             packages: org.gnome.Platform/x86_64/45 org.gnome.Sdk/x86_64/45 org.gnome.Platform/aarch64/45 org.gnome.Sdk/aarch64/45
@@ -68,15 +85,14 @@ jobs:
             packages: org.freedesktop.Sdk.Extension.llvm17/x86_64/23.08 org.freedesktop.Sdk.Extension.rust-stable/x86_64/23.08 org.gnome.Platform/x86_64/46 org.gnome.Sdk/x86_64/46 org.freedesktop.Sdk.Extension.llvm17/aarch64/23.08 org.freedesktop.Sdk.Extension.rust-stable/aarch64/23.08 org.gnome.Platform/aarch64/46 org.gnome.Sdk/aarch64/46
             remote: flathub
 
+          # KDE
+          #
+          # These are images for the KDE runtime. The maintainer doesn't use
+          # these, but feel free to open a PR if out-of-date.
           - name: kde
             tag: 5.15-23.08
             packages: org.kde.Platform/x86_64/5.15-23.08 org.kde.Sdk/x86_64/5.15-23.08 org.kde.Platform/aarch64/5.15-23.08 org.kde.Sdk/aarch64/5.15-23.08
             remote: flathub
-
-          - name: elementary
-            tag: juno-22.08
-            packages: io.elementary.BaseApp//juno-22.08 org.freedesktop.Platform//22.08 org.freedesktop.Sdk//22.08
-            remote: flathub
       fail-fast: false
 
     steps: