Add GitHub Release Object with formatting for release notes

Author: Pete Bishop

Diff for: app/Support/GitHub.php

@@ -2,6 +2,7 @@
 
 namespace App\Support;
 
+use App\Support\GitHub\Release;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Facades\Cache;
 use Illuminate\Support\Facades\Http;
@@ -31,9 +32,7 @@ public function latestVersion()
         $version = Cache::remember(
             $this->getCacheKey('latest-version'),
             now()->addHour(),
-            function () {
-                return $this->fetchLatestVersion();
-            }
+            fn () => $this->fetchLatestVersion()
         );
 
         return $version['name'] ?? 'Unknown';
@@ -44,9 +43,7 @@ public function releases(): Collection
         return Cache::remember(
             $this->getCacheKey('releases'),
             now()->addHour(),
-            function () {
-                return $this->fetchReleases();
-            }
+            fn () => $this->fetchReleases()
         );
     }
 
@@ -75,9 +72,9 @@ private function fetchReleases(): ?Collection
 
         // Check if the request was successful
         if ($response->failed()) {
-            return null;
+            return collect();
         }
 
-        return collect($response->json());
+        return collect($response->json())->map(fn (array $release) => new Release($release));
     }
 }

Diff for: app/Support/GitHub/Release.php

@@ -0,0 +1,85 @@
+<?php
+
+namespace App\Support\GitHub;
+
+/**
+ * @property string $url
+ * @property string $assets_url
+ * @property string $upload_url
+ * @property string $html_url
+ * @property int $id
+ * @property array $author
+ * @property string $node_id
+ * @property string $tag_name
+ * @property string $target_commitish
+ * @property string $name
+ * @property bool $draft
+ * @property bool $prerelease
+ * @property string $created_at
+ * @property string $published_at
+ * @property array $assets
+ * @property string $tarball_url
+ * @property string $zipball_url
+ * @property string $body
+ * @property int $mentions_count
+ */
+class Release
+{
+    private bool $withUserLinks = true;
+    private bool $convertLinks = true;
+
+    public function __construct(
+        private array $data
+    ) {
+        //
+    }
+
+    public function __get(string $name)
+    {
+        return $this->data[$name] ?? null;
+    }
+
+    public function __isset(string $name): bool
+    {
+        return isset($this->data[$name]);
+    }
+
+    public function getBodyForMarkdown(): string
+    {
+        $body = $this->body;
+
+        // Convert any URLs to Markdown links
+        if ($this->convertLinks) {
+            $body = preg_replace(
+                '/(https?:\/\/[^\s]+)/',
+                '[$1]($1)',
+                $body
+            );
+        }
+
+        // Change any @ tags to markdown links to GitHub
+        if ($this->withUserLinks) {
+            $body = preg_replace(
+                '/@([a-zA-Z0-9_]+)/',
+                '[@$1](https://github.com/$1)',
+                $body
+            );
+        }
+
+        return str_replace('#', '##', $body);
+    }
+
+    public function withoutUserLinks(bool $withoutUserLinks = true): static
+    {
+        $this->withUserLinks = ! $withoutUserLinks;
+
+        return $this;
+    }
+
+    public function withoutLinkConversion(bool $convertLinks = true): static
+    {
+        $this->convertLinks = ! $convertLinks;
+
+        return $this;
+    }
+}

Diff for: resources/views/docs/desktop/1/getting-started/release-notes.md

@@ -4,10 +4,10 @@ order: 1100
 ---
 
 @forelse (\App\Support\GitHub::electron()->releases() as $release)
-## {{ $release['name'] }}
-Released: {{ \Carbon\Carbon::parse($release['published_at'])->format('F j, Y') }}**
+## {{ $release->name }}
+**Released: {{ \Carbon\Carbon::parse($release->published_at)->format('F j, Y') }}**
 
-{{ str_replace('#', '##', $release['body']) }}
+{{ $release->getBodyForMarkdown() }}
 ---
 @empty
 ## We couldn't show you the latest release notes at this time.