feat: new build-time version injection method with git describe

.github/workflows/docker-publish.yml

@@ -28,9 +28,6 @@ jobs:
       packages: write
 
     steps:
-      - name: Checkout repository
-        uses: actions/checkout@a5ac7e51b41094c92402da3b24376905380afc29 # v4.1.6
-
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@d70bba72b1f3fd22344832f00baa16ece964efeb # v3.3.0
         with:
@@ -57,10 +54,11 @@ jobs:
       - name: Build and push Docker image
         uses: docker/build-push-action@2cdde995de11925a030ce8070c3d77a52ffcf1c0 # v5.3.0
         with:
-          context: .
           push: ${{ github.event_name != 'pull_request' }}
           platforms: linux/amd64,linux/arm64
           tags: ${{ steps.metadata.outputs.tags }}
           labels: ${{ steps.metadata.outputs.labels }}
+          build-args: |
+            BUILDKIT_CONTEXT_KEEP_GIT_DIR=1
           cache-from: type=gha
           cache-to: type=gha,mode=max

Dockerfile

@@ -22,7 +22,9 @@ ARG BUILDPLATFORM
 RUN --mount=type=cache,id=npm-$BUILDPLATFORM,target=/.npm \
     npm ci
 COPY --link ./src/ ./src/
-RUN npm run build
+COPY --link ./esbuild-plugin-metadata-injector/ ./esbuild-plugin-metadata-injector/
+COPY --link ./tsconfig.json ./
+RUN --mount=type=bind,source=./.git/,target=./.git/ npm run build
 
 FROM --platform=$BUILDPLATFORM node:20.14.0-bookworm@sha256:ab71b9da5ba19445dc5bb76bf99c218941db2c4d70ff4de4e0d9ec90920bfe3f AS dictionary
 WORKDIR /app

build.js

@@ -1,5 +1,7 @@
+// @ts-check
+
 import { build } from "esbuild";
-import { esbuildPluginVersionInjector } from "esbuild-plugin-version-injector";
+import esbuildPluginMetadataInjector from "./esbuild-plugin-metadata-injector/plugin.js";
 import packageJson from "./package.json" with { type: "json" };
 
 await build({
@@ -9,6 +11,6 @@ await build({
   platform: "node",
   format: "esm",
   external: Object.keys(packageJson.dependencies),
-  plugins: [esbuildPluginVersionInjector()],
+  plugins: [esbuildPluginMetadataInjector()],
   minify: true,
 });

esbuild-plugin-metadata-injector/placeholder.d.ts

@@ -0,0 +1,2 @@
+export const PACKAGE_VERSION: string;
+export const GIT_DESCRIBE: string;

esbuild-plugin-metadata-injector/placeholder.js

@@ -0,0 +1,7 @@
+// @ts-check
+
+import gitDescribe from "git-describe";
+import packageJSON from "../package.json" with { type: "json" };
+
+export const PACKAGE_VERSION = packageJSON.version;
+export const GIT_DESCRIBE = gitDescribe.gitDescribeSync().raw;

esbuild-plugin-metadata-injector/plugin.js

@@ -0,0 +1,29 @@
+// @ts-check
+
+import { fileURLToPath } from "node:url";
+import * as placeholder from "./placeholder.js";
+
+/**
+ * @param {string} path
+ * @returns {RegExp}
+ */
+function exact(path) {
+  return new RegExp(`^${path.replace(/[/.]/g, "\\$&")}$`);
+}
+
+const target = fileURLToPath(import.meta.resolve("./placeholder.js"));
+
+/**
+ * @returns {import("esbuild").Plugin}
+ */
+export default function esbuildPluginMetadataInjector() {
+  return {
+    name: "esbuild-plugin-metadata-injector",
+    setup(build) {
+      build.onLoad({ filter: exact(target) }, () => ({
+        loader: "json",
+        contents: JSON.stringify(placeholder),
+      }));
+    },
+  };
+}

package.json

@@ -26,10 +26,10 @@
     "@types/node": "20.14.2",
     "dotenv": "16.4.5",
     "esbuild": "0.21.5",
-    "esbuild-plugin-version-injector": "1.2.1",
     "eslint": "8.57.0",
     "eslint-config-prettier": "9.1.0",
     "eslint-plugin-import": "2.29.1",
+    "git-describe": "4.1.1",
     "globals": "15.4.0",
     "husky": "9.0.11",
     "lint-staged": "15.2.5",

src/commands/version.ts

@@ -7,7 +7,10 @@ import type {
   ChatInputCommandInteraction,
   RESTPostAPIChatInputApplicationCommandsJSONBody,
 } from "discord.js";
-import { OM_VERSION } from "../version";
+import {
+  PACKAGE_VERSION,
+  GIT_DESCRIBE,
+} from "esbuild-plugin-metadata-injector/placeholder";
 
 export const definition = {
   name: "version",
@@ -19,7 +22,7 @@ export async function handler(
 ) {
   await interaction.reply({
     content: `\`\`\`
-discordjs-japan/om: ${OM_VERSION}
+discordjs-japan/om: ${PACKAGE_VERSION} (${GIT_DESCRIBE})
 discordjs-japan/om-syrinx: ${OM_SYRINX_VERSION}
 jpreprocess/jpreprocess: ${JPREPROCESS_VERSION}
 jpreprocess/jbonsai: ${JBONSAI_VERSION}

src/main.ts

@@ -1,11 +1,11 @@
 import { ActivityType, Client, Events, GatewayIntentBits } from "discord.js";
+import { PACKAGE_VERSION } from "esbuild-plugin-metadata-injector/placeholder";
 import * as join from "./commands/join";
 import * as leave from "./commands/leave";
 import * as skip from "./commands/skip";
 import * as version from "./commands/version";
 import { ReplyableError } from "./error";
 import Pipeline from "./pipeline";
-import { OM_VERSION } from "./version";
 
 process.title = "discordjs-japan/om";
 
@@ -64,7 +64,7 @@ client.once(Events.ClientReady, async (client) => {
   ]);
   client.user.setActivity({
     type: ActivityType.Custom,
-    name: `v${OM_VERSION}`,
+    name: `v${PACKAGE_VERSION}`,
   });
 });
 

tsconfig.json

@@ -13,7 +13,12 @@
     "esModuleInterop": true,
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
-    "verbatimModuleSyntax": true
+    "verbatimModuleSyntax": true,
+    "paths": {
+      "esbuild-plugin-metadata-injector/placeholder": [
+        "./esbuild-plugin-metadata-injector/placeholder"
+      ]
+    }
   },
   "include": ["src/**/*"]
 }