Buildkite slug (#334)

lib/git.js

@@ -33,3 +33,32 @@ export function branch(options) {
     return undefined;
   }
 }
+
+// Match slug on SSH URLs (ex: `USER@HOST:PORT/ORG/REPO.git`)
+const GIT_SSH_URL_SLUG_PATTERN = /^(?:.*)@(?:.*):(?:\d+\/)?(.*)\.git$/;
+
+// Match slug on HTTP(S) URLs `https://github.com/semantic-release/env-ci.git`
+const GIT_PATHNAME_SLUG_PATTERN = /^\/(.*)\.git$/;
+
+/**
+ * Extract repository slug(owner/repo) from a repository URL
+ *
+ * @param {String} repositoryURL
+ * @returns {String | undefined}
+ */
+export function getSlugFromGitURL(repositoryURL) {
+  if (!repositoryURL) {
+    return undefined;
+  }
+
+  if (repositoryURL.match(GIT_SSH_URL_SLUG_PATTERN)) {
+    return repositoryURL.replace(GIT_SSH_URL_SLUG_PATTERN, "$1");
+  }
+
+  try {
+    const url = new URL(repositoryURL);
+    return url.pathname.replace(GIT_PATHNAME_SLUG_PATTERN, "$1");
+  } catch {
+    return undefined;
+  }
+}

services/buildkite.js

@@ -1,4 +1,5 @@
 // https://buildkite.com/docs/builds/environment-variables
+import { getSlugFromGitURL } from "../lib/git.js";
 
 export default {
   detect({ env }) {
@@ -21,7 +22,7 @@ export default {
       branch: isPr
         ? env.BUILDKITE_PULL_REQUEST_BASE_BRANCH
         : env.BUILDKITE_BRANCH,
-      slug: `${env.BUILDKITE_ORGANIZATION_SLUG}/${env.BUILDKITE_PROJECT_SLUG}`,
+      slug: getSlugFromGitURL(env.BUILDKITE_REPO),
       pr,
       isPr,
       prBranch: isPr ? env.BUILDKITE_BRANCH : undefined,

test/lib/git.test.js

@@ -1,5 +1,5 @@
 import test from "ava";
-import { head, branch } from "../../lib/git.js";
+import { getSlugFromGitURL, head, branch } from "../../lib/git.js";
 import {
   gitRepo,
   gitCommit,
@@ -38,3 +38,12 @@ test("Git cloned repository with detached head", async (t) => {
   t.is(head({ cwd }), await gitHead({ cwd }));
   t.is(branch({ cwd }), "master");
 });
+
+test("Slug from git URL", (t) => {
+  t.is(getSlugFromGitURL(""), undefined);
+  t.is(getSlugFromGitURL("invalid url"), undefined);
+  t.is(getSlugFromGitURL("https://github.com/owner/repo.git"), "owner/repo");
+  t.is(getSlugFromGitURL("[email protected]:owner/repo.git"), "owner/repo");
+  t.is(getSlugFromGitURL("[email protected]:9418/owner/repo.git"), "owner/repo");
+  t.is(getSlugFromGitURL("[email protected]:9418/owner/repo.git"), "owner/repo");
+});

test/services/buildkite.test.js

@@ -10,8 +10,7 @@ const env = {
   BUILDKITE_BRANCH: "master",
   BUILDKITE_PULL_REQUEST: "false",
   BUILDKITE_BUILD_CHECKOUT_PATH: "/",
-  BUILDKITE_ORGANIZATION_SLUG: "owner",
-  BUILDKITE_PROJECT_SLUG: "repo",
+  BUILDKITE_REPO: "[email protected]:owner/repo.git",
 };
 
 test("Push", (t) => {