feat: add last update commit+committer (#575)

* Add last author of page

* Remove debug logging and add dev note

* pnpm format

* Use GitHub token if possible and remove redundant API call

* Make time zone be dependant on client's time zone

* Undo client side time zone because scorp just told me that it runs server side anyways meaning that it would not even work regardless

* Fix incorrect author link by retrieving commit has instead of latest commit

* Add Discord server invite link

* refactor: error handling, add commit link

* fix: pass in GitHub token from workflow

* Undo tag styling

* fix: wrap

* fix: format

---------

Co-authored-by: Matouš Kučera <[email protected]>
Co-authored-by: Pedro <[email protected]>

Author: 3 people

.github/workflows/build-preview.yaml

@@ -28,6 +28,8 @@ jobs:
         run: "pnpm install"
       - name: "build"
         run: "pnpm build"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "copy cloudflare configuration files to build directory"
         run: |
           cp _headers dist/

.github/workflows/deploy.yaml

@@ -30,6 +30,8 @@ jobs:
         run: "pnpm install"
       - name: "build"
         run: "pnpm build"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: "copy cloudflare configuration files to build directory"
         run: |
           cp _headers dist/

astro.config.ts

@@ -38,6 +38,7 @@ export default defineConfig({
         Sidebar: "./src/components/overrides/Sidebar.astro",
         PageFrame: "./src/components/overrides/PageFrame.astro",
         Footer: "./src/components/overrides/Footer.astro",
+        LastUpdated: "./src/components/overrides/LastUpdated.astro",
         Banner: "./src/components/overrides/Banner.astro",
         TableOfContents: "./src/components/overrides/TableOfContents.astro",
         MobileTableOfContents: "./src/components/overrides/MobileTableOfContents.astro",

src/components/overrides/LastUpdated.astro

@@ -0,0 +1,36 @@
+---
+import { REPO, getCommitInfo } from "../../utils/git";
+
+const { lang, lastUpdated } = Astro.locals.starlightRoute;
+const filePath = Astro.locals.starlightRoute.entry.filePath;
+
+const info = await getCommitInfo(filePath);
+---
+
+{
+  lastUpdated && (
+    <p>
+      <span class="nowrap">
+        Last updated:
+        <time datetime={lastUpdated.toISOString()}>
+          {lastUpdated.toLocaleDateString(lang, {
+            dateStyle: "medium",
+            timeZone: "UTC",
+          })}
+        </time>
+      </span>{" "}
+      {info && (
+        <span class="nowrap">
+          by <a href={info.committer.href}>{info.committer.name}</a>
+          in <a href={`https://github.com/${REPO}/commit/${info.hash}`}>{info.hash.substring(0, 7)}</a>
+        </span>
+      )}
+    </p>
+  )
+}
+
+<style>
+  .nowrap {
+    white-space: nowrap;
+  }
+</style>

src/content/docs/paper/dev/api/command-api/basics/introduction.md

@@ -48,4 +48,5 @@ The following pages will be added to the documentation in the future:
 :::
 
 ## Additional support
-For support regarding the command API, you can always ask in our [Discord Server](https://discord.gg/PaperMC) in the `#paper-dev` channel!
+For support regarding the command API, you can always ask in our [Discord server](https://discord.gg/PaperMC) under the
+[`#paper-dev`](https://discord.com/channels/289587909051416579/555462289851940864) channel!

src/utils/git.ts

@@ -0,0 +1,64 @@
+import { execSync } from "child_process";
+
+export interface CommitterInfo {
+  name: string;
+  href: string;
+}
+
+export interface CommitInfo {
+  hash: string;
+  committer: CommitterInfo;
+}
+
+const token = process.env.GITHUB_TOKEN;
+
+const options: RequestInit = token
+  ? {
+      headers: {
+        Accept: "application/vnd.github+json",
+        "User-Agent": "papermc-docs/author",
+        Authorization: `Bearer ${token}`,
+      },
+    }
+  : {
+      headers: {
+        Accept: "application/vnd.github+json",
+        "User-Agent": "papermc-docs/author",
+      },
+    };
+
+export const REPO = "PaperMC/docs";
+const cache = new Map<string, CommitterInfo>();
+
+export const getCommitInfo = async (filePath: string): Promise<CommitInfo | null> => {
+  let email: string, hash: string;
+  try {
+    email = execSync(`git log -1 --pretty="format:%ae" -- "${filePath}"`).toString();
+    hash = execSync(`git log -1 --pretty="format:%H" -- "${filePath}"`).toString();
+  } catch (e) {
+    return null;
+  }
+
+  const cached = cache.get(email);
+  if (cached) {
+    return { hash, committer: cached };
+  }
+
+  let name: string;
+  try {
+    name = execSync(`git log -1 --pretty="format:%an" -- "${filePath}"`).toString();
+  } catch (e) {
+    return null;
+  }
+
+  const info: CommitterInfo = { name, href: `mailto:${email}` };
+
+  const res = await fetch(`https://api.github.com/repos/${REPO}/commits/${hash}`, options);
+  if (res.ok) {
+    const commit = await res.json();
+    info.href = commit.author.html_url;
+  }
+
+  cache.set(email, info);
+  return { hash, committer: info };
+};