Merge pull request #21809 from AnnsAnns/improve_changelog

Starlight/Changelog: Add direct Github link support

Author: Teufelchen1

.editorconfig

@@ -14,3 +14,9 @@ indent_size = 2
 tab_size = 2
 trim_trailing_whitespace = true
 insert_final_newline = true
+
+[*{.astro, .js, .ts, .mjs, .json}]
+indent_style = space
+indent_size = 2
+trim_trailing_whitespace = true
+insert_final_newline = true

doc/starlight/src/content.config.ts

@@ -97,6 +97,13 @@ export function changelogLoader(): Loader {
               .slice(currentReleaseHeadingIndex + 1, index)
               .join("\n");
 
+            // Replace #ID entries with links to GitHub issues
+            // Github treats both PRs and Issues the same way regarding links
+            const contentWithGithubLinks = currentReleaseContent.replace(
+              /#(\d+)/g,
+              "[#$1](https://github.com/RIOT-OS/RIOT/issues/$1)",
+            );
+
             // Add entry to content collection
             context.store.set({
               id: slug,
@@ -108,9 +115,9 @@ export function changelogLoader(): Loader {
                 codeName: codeName,
                 slug: slug,
                 date: date,
-                markdown: currentReleaseContent,
+                markdown: contentWithGithubLinks,
               },
-              rendered: await context.renderMarkdown(currentReleaseContent),
+              rendered: await context.renderMarkdown(contentWithGithubLinks),
             });
           }
 

doc/starlight/src/pages/changelog/[version].astro

@@ -1,5 +1,6 @@
 ---
 import StarlightPage from "@astrojs/starlight/components/StarlightPage.astro";
+import { LinkCard } from "@astrojs/starlight/components";
 import { getCollection, render } from "astro:content";
 
 export async function getStaticPaths() {
@@ -26,5 +27,11 @@ const { Content, headings } = await render(entry);
     pagefind: false, // We don't want to pollute our search with release-notes entries
   }}
   headings={headings}
-  ><Content />
+>
+  <LinkCard
+    title="View on GitHub"
+    href={`https://github.com/RIOT-OS/RIOT/releases/tag/${entry.data.slug.replaceAll("-", ".")}`}
+    description="The changelog can also be found on GitHub."
+  />
+  <Content />
 </StarlightPage>