Add/improve dynamic mod version fetching

Author: Strokkur424

astro.config.ts

@@ -10,6 +10,7 @@ import javadocPlugin from "./src/utils/remark/javadoc";
 import {
   LATEST_ADVENTURE_ANSI_RELEASE,
   LATEST_ADVENTURE_API_RELEASE,
+  LATEST_ADVENTURE_PLATFORM_MOD_RELEASE,
   LATEST_ADVENTURE_PLATFORM_RELEASE,
   LATEST_MC_RELEASE,
   LATEST_PAPER_RELEASE,
@@ -520,6 +521,7 @@ export default defineConfig({
             LATEST_USERDEV_RELEASE,
             LATEST_ADVENTURE_API_RELEASE,
             LATEST_ADVENTURE_PLATFORM_RELEASE,
+            LATEST_ADVENTURE_PLATFORM_MOD_RELEASE,
             LATEST_ADVENTURE_ANSI_RELEASE,
           },
         },

src/components/adventure/ModPlatformDependency.astro

@@ -0,0 +1,53 @@
+---
+import { Tabs, TabItem, Code } from "@astrojs/starlight/components";
+import { LATEST_ADVENTURE_PLATFORM_MOD_RELEASE } from "/src/utils/versions";
+
+interface Props {
+  platform: string;
+}
+
+const props: Props = Astro.props;
+const mavenCoords = `net.kyori:adventure-platform-${props.platform}:${LATEST_ADVENTURE_PLATFORM_MOD_RELEASE}`;
+
+const groovy = `
+  repositories {
+    // for development builds
+    maven {
+        name = "sonatype-oss-snapshots1"
+        url = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
+        mavenContent { snapshotsOnly() }
+    }
+    // for releases
+    mavenCentral()
+  }
+
+  dependencies {
+      modImplementation include("${mavenCoords}") // for Minecraft 1.21.5
+  }
+`;
+
+const kotlin = `
+  repositories {
+    // for development builds
+    maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/") {
+        name = "sonatype-oss-snapshots1"
+        mavenContent { snapshotsOnly() }
+    }
+    // for releases
+    mavenCentral()
+  }
+
+  dependencies {
+      modImplementation(include("${mavenCoords}")!!) // for Minecraft 1.21.5
+  }
+`;
+---
+
+<Tabs syncKey="build-system">
+  <TabItem label="Gradle (Groovy)">
+    <Code lang="groovy" code={groovy} />
+  </TabItem>
+  <TabItem label="Gradle (Kotlin)">
+    <Code lang="kotlin" code={kotlin} />
+  </TabItem>
+</Tabs>

src/content/docs/adventure/platform/fabric.mdx

@@ -3,7 +3,7 @@ title: Fabric
 description: The Fabric Adventure implementation.
 ---
 
-import { Tabs, TabItem } from "@astrojs/starlight/components"
+import ModPlatformDependency from "/src/components/adventure/ModPlatformDependency.astro";
 
 Adventure supports Fabric on *Minecraft: Java Edition* 1.16 and up, for both server-side and client-side use. Each major version of Minecraft
 will usually require a new release of the platform.
@@ -25,44 +25,7 @@ Starting with Minecraft 1.21.2, both platforms have version 6.x published.
 The Fabric platform is packaged as a mod, designed to be included in mods via jar-in-jar packaging.
 As with the rest of the Adventure projects, releases are distributed on Maven Central, and snapshots on Sonatype OSS:
 
-// TODO: Make this a component + insert version placeholder
-<Tabs syncKey="build-system">
-  <TabItem label="Gradle (Groovy)">
-  ```groovy
-  repositories {
-    // for development builds
-    maven {
-        name = "sonatype-oss-snapshots1"
-        url = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
-        mavenContent { snapshotsOnly() }
-    }
-    // for releases
-    mavenCentral()
-  }
-
-  dependencies {
-      modImplementation include("net.kyori:adventure-platform-fabric:|mod_version|") // for Minecraft 1.21.5
-  }
-  ```
-  </TabItem>
-  <TabItem label="Gradle (Kotlin)">
-  ```kts
-  repositories {
-    // for development builds
-    maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/") {
-        name = "sonatype-oss-snapshots1"
-        mavenContent { snapshotsOnly() }
-    }
-    // for releases
-    mavenCentral()
-  }
-
-  dependencies {
-      modImplementation(include("net.kyori:adventure-platform-fabric:|modversion|")!!) // for Minecraft 1.21.5
-  }
-  ```
-  </TabItem>
-</Tabs>
+<ModPlatformDependency platform="fabric" />
 
 The Fabric platform requires *fabric-api-base* in order to provide the locale change event, *fabric-command-api-v2* for the callback click event,
 and can optionally use [Colonel](https://gitlab.com/stellardrift/colonel) (or *fabric-networking-api-v1*) to allow the `Component` and `Key` argument

src/content/docs/adventure/platform/modded.mdx

@@ -24,10 +24,9 @@ then you don't need to use this artifact explicitly. This is because both platfo
 
 As with the rest of the Adventure projects, releases are distributed on Maven Central, and snapshots on Sonatype OSS:
 
-// TODO: Make this a component + insert version placeholder
 <Tabs syncKey="build-system">
   <TabItem label="Gradle (Groovy)">
-  ```groovy
+  ```groovy replace
   repositories {
     // for development builds
     maven {
@@ -41,15 +40,15 @@ As with the rest of the Adventure projects, releases are distributed on Maven Ce
 
   dependencies {
     // Loom project
-    modCompileOnly("net.kyori:adventure-platform-mod-shared-fabric-repack:|mod_version|") // for Minecraft 1.21.5
+    modCompileOnly("net.kyori:adventure-platform-mod-shared-fabric-repack:\{LATEST_ADVENTURE_PLATFORM_MOD_RELEASE}") // for Minecraft 1.21.5
 
     // NeoGradle/ModDevGradle/VanillaGradle project
-    compileOnly("net.kyori:adventure-platform-mod-shared:|mod_version|") // for Minecraft 1.21.5
+    compileOnly("net.kyori:adventure-platform-mod-shared:\{LATEST_ADVENTURE_PLATFORM_MOD_RELEASE}") // for Minecraft 1.21.5
   }
   ```
   </TabItem>
   <TabItem label="Gradle (Kotlin)">
-  ```kts
+  ```kts replace
   repositories {
     // for development builds
     maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/") {
@@ -62,10 +61,10 @@ As with the rest of the Adventure projects, releases are distributed on Maven Ce
 
   dependencies {
     // Loom project
-    modCompileOnly("net.kyori:adventure-platform-mod-shared-fabric-repack:|mod_version|") // for Minecraft 1.21.5
+    modCompileOnly("net.kyori:adventure-platform-mod-shared-fabric-repack:\{LATEST_ADVENTURE_PLATFORM_MOD_RELEASE}") // for Minecraft 1.21.5
 
     // NeoGradle/ModDevGradle/VanillaGradle project
-    compileOnly("net.kyori:adventure-platform-mod-shared:|mod_version|") // for Minecraft 1.21.5
+    compileOnly("net.kyori:adventure-platform-mod-shared:\{LATEST_ADVENTURE_PLATFORM_MOD_RELEASE}") // for Minecraft 1.21.5
   }
   ```
   </TabItem>

src/content/docs/adventure/platform/neoforge.mdx

@@ -3,7 +3,7 @@ title: NeoForge
 description: The NeoForge Adventure implementation.
 ---
 
-import { Tabs, TabItem } from "@astrojs/starlight/components"
+import ModPlatformDependency from "/src/components/adventure/ModPlatformDependency.astro";
 
 Adventure supports NeoForge on *Minecraft: Java Edition* 1.21 and up, for both server-side and client-side use. Each major version of Minecraft will usually require
 a new release of the platform.
@@ -15,44 +15,7 @@ The platform supports all features, including localization and custom renderers.
 The NeoForge platform is packaged as a mod, designed to be included in mods via jar-in-jar packaging. As with the rest of the Adventure projects,
 releases are distributed on Maven Central, and snapshots on Sonatype OSS:
 
-// TODO: Make this a component + insert version placeholder
-<Tabs syncKey="build-system">
-  <TabItem label="Gradle (Groovy)">
-  ```groovy
-  repositories {
-    // for development builds
-    maven {
-        name = "sonatype-oss-snapshots1"
-        url = "https://s01.oss.sonatype.org/content/repositories/snapshots/"
-        mavenContent { snapshotsOnly() }
-    }
-    // for releases
-    mavenCentral()
-  }
-
-  dependencies {
-    implementation jarJar("net.kyori:adventure-platform-neoforge:|mod_version|") // for Minecraft 1.21.5
-  }
-  ```
-  </TabItem>
-  <TabItem label="Gradle (Kotlin)">
-  ```kts
-  repositories {
-    // for development builds
-    maven(url = "https://s01.oss.sonatype.org/content/repositories/snapshots/") {
-        name = "sonatype-oss-snapshots1"
-        mavenContent { snapshotsOnly() }
-    }
-    // for releases
-    mavenCentral()
-  }
-
-  dependencies {
-    implementation(jarJar("net.kyori:adventure-platform-neoforge:|mod_version|")!!) // for Minecraft 1.21.5
-  }
-  ```
-  </TabItem>
-</Tabs>
+<ModPlatformDependency platform="neoforge" />
 
 :::danger[Attention]
 

src/utils/releases.ts

@@ -4,6 +4,7 @@ interface Release {
   published: string;
   url: string;
   tag: string;
+  tag_name: string;
 }
 
 const token = process.env.GITHUB_TOKEN;
@@ -43,6 +44,7 @@ export async function fetchRelease(repo: string): Promise<Release[]> {
         published: obj.published_at ?? "2000-01-01",
         url: obj.html_url ?? "about:blank",
         tag: obj.tag_name?.replaceAll(".", "-") ?? "none",
+        tag_name: obj.tag_name ?? "v1.0.0"
       };
     })
     // Post-processing
@@ -78,19 +80,7 @@ function handleRegex(obj: Release, regex: RegExp, onMatch: (match: string) => st
   }
 
   const alreadyMatched: string[] = [];
-  let result = obj.body.matchAll(regex);
-  if (result == null) {
-    console.warn("Result of match was null.");
-    return;
-  }
-
-  console.info(result);
-  if (result.map == null) {
-    console.warn("Yeah it cannot find the map method");
-    return;
-  }
-
-  result
+  obj.body.matchAll(regex)
     .map((match) => match[0])
     .forEach((match) => {
       if (alreadyMatched.find((e) => e == match) != null) {

src/utils/versions.ts

@@ -67,6 +67,10 @@ const adventurePlatformVersions: string[] = await fetchGitHubTags("KyoriPowered/
 
 export const LATEST_ADVENTURE_PLATFORM_RELEASE = adventurePlatformVersions[0];
 
+const adventurePlatformModVersions: string[] = await fetchGitHubTags("KyoriPowered/adventure-platform-mod");
+
+export const LATEST_ADVENTURE_PLATFORM_MOD_RELEASE = adventurePlatformModVersions[0];
+
 const adventureAnsiVersions: string[] = await fetchGitHubTags("KyoriPowered/ansi");
 
 export const LATEST_ADVENTURE_ANSI_RELEASE = adventureAnsiVersions[0];
@@ -79,5 +83,6 @@ export const LATEST_RELEASES: Record<string, string> = {
   userdev: LATEST_USERDEV_RELEASE,
   "adventure-api": LATEST_ADVENTURE_API_RELEASE,
   "adventure-platform": LATEST_ADVENTURE_PLATFORM_RELEASE,
+  "adventure-platform-mod": LATEST_ADVENTURE_PLATFORM_MOD_RELEASE,
   "adventure-ansi": LATEST_ADVENTURE_ANSI_RELEASE,
 };