From 5968d1107944d898e3b9fb80f036f351b085a137 Mon Sep 17 00:00:00 2001
From: Leo Ribeiro <leonardo@squareup.com>
Date: Thu, 21 Nov 2024 05:16:26 -0800
Subject: [PATCH] Add a few piloting projects (#16)

---
 .../src/components/ProjectDetails.astro       | 15 ++++-
 projects-dashboard/src/content/config.ts      | 20 ++++---
 .../content/project/TBD54566975_tbdex-rust.md |  1 +
 .../content/project/TBD54566975_web5-js.md    |  1 +
 .../project/block_example-jvm-maven.md        |  3 +-
 .../src/content/project/block_goose.md        | 40 +++++++++++++
 .../src/content/project/block_radiography.md  | 43 ++++++++++++++
 .../project/cashapp_AccessibilitySnapshot.md  | 44 ++++++++++++++
 .../src/content/project/square_okhttp.md      | 49 +++++++++++++++
 .../src/content/project/square_okio.md        | 51 ++++++++++++++++
 projects-dashboard/src/lib/badge.ts           | 59 +++++++++++++++----
 projects-dashboard/src/pages/index.astro      | 16 ++---
 12 files changed, 315 insertions(+), 27 deletions(-)
 create mode 100644 projects-dashboard/src/content/project/block_goose.md
 create mode 100644 projects-dashboard/src/content/project/block_radiography.md
 create mode 100644 projects-dashboard/src/content/project/cashapp_AccessibilitySnapshot.md
 create mode 100644 projects-dashboard/src/content/project/square_okhttp.md
 create mode 100644 projects-dashboard/src/content/project/square_okio.md

diff --git a/projects-dashboard/src/components/ProjectDetails.astro b/projects-dashboard/src/components/ProjectDetails.astro
index 8d6e9d1..7242fb1 100644
--- a/projects-dashboard/src/components/ProjectDetails.astro
+++ b/projects-dashboard/src/components/ProjectDetails.astro
@@ -20,6 +20,7 @@ const {
   packages,
   lifeCycleStatus,
   contributing,
+  website,
 } = Astro.props;
 ---
 
@@ -53,7 +54,17 @@ const {
         ))
     }
   </div>
-  <p>{description}</p>
+  <p>
+    {description}
+    {website && (
+      <>
+        <br />
+        <a href={website} target="_blank">
+          <small>{website}</small>
+        </a>
+      </>
+    )}
+  </p>
   <div class="project-details-cards-grid">
     {
       ciChecks && (
@@ -113,7 +124,7 @@ const {
 
 <style>
   .project-details {
-    margin-bottom: 2em;
+    margin-bottom: 4rem;
   }
 
   .project-details h3 {
diff --git a/projects-dashboard/src/content/config.ts b/projects-dashboard/src/content/config.ts
index 28e1b5a..169ceae 100644
--- a/projects-dashboard/src/content/config.ts
+++ b/projects-dashboard/src/content/config.ts
@@ -3,6 +3,7 @@ import { defineCollection, z } from "astro:content";
 const repoSchema = z.object({
   owner: z.string(),
   name: z.string(),
+  mainBranch: z.string().optional(),
 });
 
 export type Repo = z.infer<typeof repoSchema>;
@@ -21,7 +22,13 @@ const languageSchema = z.enum([
 
 export type Language = z.infer<typeof languageSchema>;
 
-const artifactTypeSchema = z.enum(["npm", "maven", "reference-docs"]);
+const artifactTypeSchema = z.enum([
+  "npm",
+  "maven",
+  "reference-docs",
+  "pypi",
+  "cocoapods",
+]);
 
 export type ArtifactType = z.infer<typeof artifactTypeSchema>;
 
@@ -50,6 +57,8 @@ const badgeTypeSchema = z.enum([
   "codecov",
   "tbd-vectors",
   "npm",
+  "pypi",
+  "cocoapods",
   "maven",
   "reference-docs",
   "life-cycle-status",
@@ -58,6 +67,7 @@ const badgeTypeSchema = z.enum([
   "issues",
   "discord",
   "mailing-list",
+  "github-discussions",
 ]);
 
 export type BadgeType = z.infer<typeof badgeTypeSchema>;
@@ -79,12 +89,7 @@ const lifeCycleStatusSchema = z.enum([
 
 export type LifeCycleStatus = z.infer<typeof lifeCycleStatusSchema>;
 
-const brandingSchema = z.enum([
-  "block",
-  "square", 
-  "cashapp",
-  "tbd",
-]);
+const brandingSchema = z.enum(["block", "square", "cashapp", "tbd"]);
 
 export type Branding = z.infer<typeof brandingSchema>;
 
@@ -92,6 +97,7 @@ const projectSchema = z.object({
   repo: repoSchema,
   description: z.string().optional(),
   title: z.string().optional(),
+  website: z.string().optional(),
   lifeCycleStatus: lifeCycleStatusSchema.optional(),
   branding: brandingSchema,
   packages: z.array(packageSchema).optional(),
diff --git a/projects-dashboard/src/content/project/TBD54566975_tbdex-rust.md b/projects-dashboard/src/content/project/TBD54566975_tbdex-rust.md
index 9698880..9ce5302 100644
--- a/projects-dashboard/src/content/project/TBD54566975_tbdex-rust.md
+++ b/projects-dashboard/src/content/project/TBD54566975_tbdex-rust.md
@@ -4,6 +4,7 @@ repo:
   name: "tbdex-rs"
 title: "tbDEX Rust"
 description: "The tbDEX Rust implementation"
+website: "https://developer.tbd.website/docs/tbdex/"
 branding: "tbd"
 lifeCycleStatus: "archived"
 ciChecks:
diff --git a/projects-dashboard/src/content/project/TBD54566975_web5-js.md b/projects-dashboard/src/content/project/TBD54566975_web5-js.md
index f48e281..9c45552 100644
--- a/projects-dashboard/src/content/project/TBD54566975_web5-js.md
+++ b/projects-dashboard/src/content/project/TBD54566975_web5-js.md
@@ -4,6 +4,7 @@ repo:
   name: "web5-js"
 title: "Web5 JS"
 description: "A JavaScript implementation of the Web5 protocol"
+website: "https://developer.tbd.website/docs/web5/"
 branding: "tbd"
 lifeCycleStatus: "archived"
 ciChecks:
diff --git a/projects-dashboard/src/content/project/block_example-jvm-maven.md b/projects-dashboard/src/content/project/block_example-jvm-maven.md
index ebac214..626d2fe 100644
--- a/projects-dashboard/src/content/project/block_example-jvm-maven.md
+++ b/projects-dashboard/src/content/project/block_example-jvm-maven.md
@@ -32,7 +32,8 @@ contributing:
     value: "CONTRIBUTING.md"
   - type: "issues"
   - type: "discord"
-    value: "https://discord.gg/3fHnCA8C"
+    value: "https://discord.com/invite/block-opensource"
+  - type: "github-discussions"
   - type: "mailing-list"
     value: "https://groups.google.com/g/tbd"
 
diff --git a/projects-dashboard/src/content/project/block_goose.md b/projects-dashboard/src/content/project/block_goose.md
new file mode 100644
index 0000000..07ddedc
--- /dev/null
+++ b/projects-dashboard/src/content/project/block_goose.md
@@ -0,0 +1,40 @@
+---
+repo:
+  owner: "block"
+  name: "goose"
+title: "Goose"
+description: "Goose is a developer agent that operates from your command line to help you do the boring stuff."
+branding: "block"
+lifeCycleStatus: "incubation"
+website: "https://block.github.io/goose/"
+ciChecks:
+  - type: "github-actions"
+    label: "ci"
+    value: "ci.yaml"
+licenses:
+  - type: "github-license"
+securityScans:
+  - type: "github-actions"
+    label: "license-check"
+    value: "license-check.yml"
+  # TODO: add security scans (eg FOSSA)
+# scoreCards: # todo
+# tests: # todo add codecov
+contributing:
+  # - type: "code-of-conduct"
+  #   value: "CODE_OF_CONDUCT.md" # TODO
+  - type: "contribution-guidelines"
+    value: "CONTRIBUTING.md"
+  - type: "issues"
+  - type: "discord"
+    value: "https://discord.com/channels/1287729918100246654/1287729920319033345"
+  - type: "github-discussions"
+
+packages:
+  - packageName: "goose-ai"
+    repoPath: "src/goose"
+    language: "python"
+    artifacts:
+      - type: "pypi"
+        value: "goose-ai"
+---
diff --git a/projects-dashboard/src/content/project/block_radiography.md b/projects-dashboard/src/content/project/block_radiography.md
new file mode 100644
index 0000000..a5e19a0
--- /dev/null
+++ b/projects-dashboard/src/content/project/block_radiography.md
@@ -0,0 +1,43 @@
+---
+repo:
+  owner: "block"
+  name: "radiography"
+title: "Radiography"
+description: "Text-ray goggles for your Android UI"
+branding: "block"
+lifeCycleStatus: "mature"
+ciChecks:
+  - type: "github-actions"
+    label: "android"
+    value: "android.yml"
+licenses:
+  - type: "github-license"
+# securityScans: #TODO
+#   - type: "fossa-license"
+#   - type: "fossa-security"
+#   - type: "github-actions"
+#     label: "scan"
+#     value: "security.yml"
+#   - type: "github-actions"
+#     label: "CodeQL"
+#     value: "codeql.yml"
+# scoreCards:
+#   - type: "ossf"
+# tests: # TODO
+#   - type: "codecov"
+contributing:
+  - type: "code-of-conduct"
+    value: "CODE_OF_CONDUCT.md"
+  - type: "contribution-guidelines"
+    value: "CONTRIBUTING.md"
+  - type: "issues"
+  - type: "github-discussions"
+
+packages:
+  - packageName: "java-kotlin-maven-example-api"
+    repoPath: "api"
+    language: "kotlin"
+    artifacts:
+      - type: "maven"
+        value: "com.squareup.radiography/radiography"
+---
diff --git a/projects-dashboard/src/content/project/cashapp_AccessibilitySnapshot.md b/projects-dashboard/src/content/project/cashapp_AccessibilitySnapshot.md
new file mode 100644
index 0000000..b83dca8
--- /dev/null
+++ b/projects-dashboard/src/content/project/cashapp_AccessibilitySnapshot.md
@@ -0,0 +1,44 @@
+---
+repo:
+  owner: "cashapp"
+  name: "AccessibilitySnapshot"
+  mainBranch: "master"
+title: "AccessibilitySnapshot"
+description: "Easy regression testing for iOS accessibility"
+branding: "cashapp"
+lifeCycleStatus: "mature"
+ciChecks:
+  - type: "github-actions"
+    label: "ci"
+    value: "ci.yml"
+licenses:
+  - type: "github-license"
+# securityScans: # TODO
+# - type: "fossa-license"
+# - type: "fossa-security"
+# - type: "github-actions"
+#   label: "scan"
+#   value: "security.yml"
+# - type: "github-actions"
+#   label: "CodeQL"
+#   value: "codeql.yml"
+# scoreCards:
+#   - type: "ossf"
+tests:
+  - type: "codecov"
+contributing:
+  # - type: "code-of-conduct"
+  #   value: "CODE_OF_CONDUCT.md" # TODO
+  - type: "contribution-guidelines"
+    value: "CONTRIBUTING.md"
+  - type: "issues"
+  - type: "github-discussions"
+
+packages:
+  - packageName: "AccessibilitySnapshot"
+    repoPath: "api"
+    language: "swift"
+    artifacts:
+      - type: "cocoapods"
+        value: "AccessibilitySnapshot"
+---
diff --git a/projects-dashboard/src/content/project/square_okhttp.md b/projects-dashboard/src/content/project/square_okhttp.md
new file mode 100644
index 0000000..e8264d7
--- /dev/null
+++ b/projects-dashboard/src/content/project/square_okhttp.md
@@ -0,0 +1,49 @@
+---
+repo:
+  owner: "square"
+  name: "okhttp"
+  mainBranch: "master"
+title: "OkHttp"
+description: "Square’s meticulous HTTP client for the JVM, Android, and GraalVM."
+branding: "square"
+lifeCycleStatus: "mature"
+website: "https://square.github.io/okhttp/"
+ciChecks:
+  - type: "github-actions"
+    label: "build"
+    value: "build.yml"
+# licenses:
+#   - type: "github-license"
+# securityScans:
+#   - type: "fossa-license"
+#   - type: "fossa-security"
+#   - type: "github-actions"
+#     label: "scan"
+#     value: "security.yml"
+#   - type: "github-actions"
+#     label: "CodeQL"
+#     value: "codeql.yml"
+# scoreCards:
+#   - type: "ossf" # TODO
+tests:
+  - type: "codecov"
+contributing:
+  # - type: "code-of-conduct"
+  #   value: "CODE_OF_CONDUCT.md"
+  - type: "contribution-guidelines"
+    value: "CONTRIBUTING.md"
+  - type: "issues"
+  # - type: "discord"
+  #   value: "https://discord.com/invite/block-opensource"
+  # - type: "github-discussions"
+  # - type: "mailing-list"
+  #   value: "https://groups.google.com/g/tbd"
+
+packages:
+  - packageName: "okhttp"
+    repoPath: "api"
+    language: "java"
+    artifacts:
+      - type: "maven"
+        value: "com.squareup.okhttp3/okhttp"
+---
diff --git a/projects-dashboard/src/content/project/square_okio.md b/projects-dashboard/src/content/project/square_okio.md
new file mode 100644
index 0000000..16aa43b
--- /dev/null
+++ b/projects-dashboard/src/content/project/square_okio.md
@@ -0,0 +1,51 @@
+---
+repo:
+  owner: "square"
+  name: "okio"
+  mainBranch: "master"
+title: "okio"
+description: "A modern I/O library for Android, Java, and Kotlin Multiplatform."
+branding: "square"
+lifeCycleStatus: "mature"
+website: "https://square.github.io/okio/"
+ciChecks:
+  - type: "github-actions"
+    label: "build"
+    value: "build.yml"
+# licenses:
+#   - type: "github-license"
+# securityScans:
+#   - type: "fossa-license"
+#   - type: "fossa-security"
+#   - type: "github-actions"
+#     label: "scan"
+#     value: "security.yml"
+#   - type: "github-actions"
+#     label: "CodeQL"
+#     value: "codeql.yml"
+# scoreCards:
+#   - type: "ossf" # TODO
+tests:
+  - type: "codecov"
+contributing:
+  - type: "code-of-conduct"
+    value: "docs/code_of_conduct.md"
+  - type: "contribution-guidelines"
+    value: "CONTRIBUTING.md"
+  - type: "issues"
+  # - type: "discord"
+  #   value: "https://discord.com/invite/block-opensource"
+  # - type: "github-discussions"
+  # - type: "mailing-list"
+  #   value: "https://groups.google.com/g/tbd"
+
+packages:
+  - packageName: "okio"
+    repoPath: "api"
+    language: "java"
+    artifacts:
+      - type: "maven"
+        value: "com.squareup.okio/okio"
+      - type: "reference-docs"
+        value: "https://square.github.io/okio/3.x/okio/okio/okio/"
+---
diff --git a/projects-dashboard/src/lib/badge.ts b/projects-dashboard/src/lib/badge.ts
index 713b6e8..62f6e2c 100644
--- a/projects-dashboard/src/lib/badge.ts
+++ b/projects-dashboard/src/lib/badge.ts
@@ -1,8 +1,9 @@
-import type { BadgeType, LifeCycleStatus } from "../content/config";
+import type { BadgeType } from "../content/config";
 
 interface Repo {
   owner: string;
   name: string;
+  mainBranch?: string;
 }
 
 function getDefaultBadgeSource(
@@ -18,14 +19,16 @@ function getGithubActionsBadge(
   value = "ci.yml",
   label = "ci"
 ): [string, string] {
-  const badgeSrc = `https://img.shields.io/github/actions/workflow/status/${repo.owner}/${repo.name}/${value}?style=flat-square&branch=main&logo=github&label=${label}&logoColor=FFFFFF`;
+  const branch = repo.mainBranch ?? "main";
+  const badgeSrc = `https://img.shields.io/github/actions/workflow/status/${repo.owner}/${repo.name}/${value}?style=flat-square&branch=${branch}&logo=github&label=${label}&logoColor=FFFFFF`;
   const href = `https://github.com/${repo.owner}/${repo.name}/actions/workflows/${value}`;
   return [badgeSrc, href];
 }
 
 function getGithubLicenseBadge(repo: Repo): [string, string] {
+  const branch = repo.mainBranch ?? "main";
   const badgeSrc = `https://img.shields.io/github/license/${repo.owner}/${repo.name}?style=flat-square&color=4c1&label=license`;
-  const href = `https://github.com/${repo.owner}/${repo.name}/blob/main/LICENSE`;
+  const href = `https://github.com/${repo.owner}/${repo.name}/blob/${branch}/LICENSE`;
   return [badgeSrc, href];
 }
 
@@ -51,7 +54,8 @@ function getOssfBadge(repo: Repo): [string, string] {
 }
 
 function getCodecovBadge(repo: Repo): [string, string] {
-  const badgeSrc = `https://img.shields.io/codecov/c/gh/${repo.owner}/${repo.name}/main?label=codecov&style=flat-square&token=YI87CKF1LI`;
+  const branch = repo.mainBranch ?? "main";
+  const badgeSrc = `https://img.shields.io/codecov/c/gh/${repo.owner}/${repo.name}/${branch}?label=codecov&style=flat-square&token=YI87CKF1LI`;
   const href = `https://codecov.io/github/${repo.owner}/${repo.name}`;
   return [badgeSrc, href];
 }
@@ -66,21 +70,39 @@ function getNpmBadge(value?: string): [string, string] {
   if (!value) {
     throw new Error("NPM package artifact value is required for badge");
   }
-  const badgeSrc = `https://img.shields.io/npm/v/${value}.svg?style=flat-square&logo=npm&label=npm ${value}&logoColor=FFFFFF&color=4c1`;
+  const badgeSrc = `https://img.shields.io/npm/v/${value}.svg?style=flat-square&logo=npm&label=npm ${value}&logoColor=FFFFFF`;
   const href = `https://www.npmjs.com/package/${value}`;
   return [badgeSrc, href];
 }
 
+function getPypiBadge(value?: string): [string, string] {
+  if (!value) {
+    throw new Error("PyPI package artifact value is required for badge");
+  }
+  const badgeSrc = `https://img.shields.io/pypi/v/${value}.svg?style=flat-square&logo=pypi&label=pypi ${value}&logoColor=FFFFFF`;
+  const href = `https://pypi.org/project/${value}`;
+  return [badgeSrc, href];
+}
+
 function getMavenBadge(value?: string): [string, string] {
   if (!value) {
     throw new Error("Maven package artifact value is required for badge");
   }
   const artifactName = value.split("/")[1];
-  const badgeSrc = `https://img.shields.io/maven-central/v/${value}?color=b07219&label=mvn ${artifactName}&logo=apachemaven&style=flat-square`
+  const badgeSrc = `https://img.shields.io/maven-central/v/${value}?color=b07219&label=mvn ${artifactName}&logo=apachemaven&style=flat-square`;
   const href = `https://central.sonatype.com/artifact/${value}`;
   return [badgeSrc, href];
 }
 
+function getCocoapodsBadge(value?: string): [string, string] {
+  if (!value) {
+    throw new Error("Cocoapods package artifact value is required for badge");
+  }
+  const badgeSrc = `https://img.shields.io/cocoapods/v/${value}?style=flat-square&logo=cocoapods&label=pod ${value}&logoColor=FFFFFF`;
+  const href = `https://cocoapods.org/pods/${value}`;
+  return [badgeSrc, href];
+}
+
 function getReferenceDocsBadge(value?: string): [string, string] {
   if (!value) {
     throw new Error("Reference docs URL is required for badge");
@@ -91,14 +113,19 @@ function getReferenceDocsBadge(value?: string): [string, string] {
 }
 
 function getCodeOfConductBadge(repo: Repo, value?: string): [string, string] {
+  const branch = repo.mainBranch ?? "main";
   const badgeSrc = `https://img.shields.io/badge/Code of Conduct-blue?style=flat-square`;
-  const href = `https://github.com/${repo.owner}/${repo.name}/blob/main/${value}`;
+  const href = `https://github.com/${repo.owner}/${repo.name}/blob/${branch}/${value}`;
   return [badgeSrc, href];
 }
 
-function getContributionGuidelinesBadge(repo: Repo, value?: string): [string, string] {
+function getContributionGuidelinesBadge(
+  repo: Repo,
+  value?: string
+): [string, string] {
+  const branch = repo.mainBranch ?? "main";
   const badgeSrc = `https://img.shields.io/badge/Contribution Guidelines-orange?style=flat-square`;
-  const href = `https://github.com/${repo.owner}/${repo.name}/blob/main/${value}`;
+  const href = `https://github.com/${repo.owner}/${repo.name}/blob/${branch}/${value}`;
   return [badgeSrc, href];
 }
 
@@ -115,7 +142,7 @@ function getMailingListBadge(value?: string): [string, string] {
   if (!value) {
     throw new Error("Mailing list URL is required for badge");
   }
-  const badgeSrc = `https://img.shields.io/badge/Mailing List-pink?style=flat-square&logo=mailboxdotorg&logoColor=FFFFFF`;
+  const badgeSrc = `https://img.shields.io/badge/Mailing List-EA4335?style=flat-square&logo=gmail&logoColor=FFFFFF`;
   const href = value;
   return [badgeSrc, href];
 }
@@ -157,6 +184,12 @@ function getGithubRepoBadge(repo: Repo): [string, string] {
   return [badgeSrc, href];
 }
 
+function getGithubDiscussionsBadge(repo: Repo): [string, string] {
+  const badgeSrc = `https://img.shields.io/badge/GitHub Discussions-black?style=flat-square&logo=github`;
+  const href = `https://github.com/${repo.owner}/${repo.name}/discussions`;
+  return [badgeSrc, href];
+}
+
 function getIssuesBadge(repo: Repo): [string, string] {
   const badgeSrc = `https://img.shields.io/github/issues/${repo.owner}/${repo.name}?style=flat-square`;
   const href = `https://github.com/${repo.owner}/${repo.name}/issues`;
@@ -190,6 +223,10 @@ export function getBadgeInfo(
       return getNpmBadge(value);
     case "maven":
       return getMavenBadge(value);
+    case "pypi":
+      return getPypiBadge(value);
+    case "cocoapods":
+      return getCocoapodsBadge(value);
     case "reference-docs":
       return getReferenceDocsBadge(value);
     case "life-cycle-status":
@@ -206,6 +243,8 @@ export function getBadgeInfo(
       return getMailingListBadge(value);
     case "issues":
       return getIssuesBadge(repo);
+    case "github-discussions":
+      return getGithubDiscussionsBadge(repo);
     default:
       return [
         getDefaultBadgeSource(type, label ?? "badge", value ?? "value"),
diff --git a/projects-dashboard/src/pages/index.astro b/projects-dashboard/src/pages/index.astro
index ed13569..72bb6ec 100644
--- a/projects-dashboard/src/pages/index.astro
+++ b/projects-dashboard/src/pages/index.astro
@@ -6,7 +6,16 @@ import ProjectDetails from '../components/ProjectDetails.astro';
 const projects = await getCollection('project');
 
 const orgs = Array.from(new Set(projects.map(project => project.data.repo.owner)));
+
+// sort orgs alphabetically
 orgs.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()));
+
+// sort projects alphabetically by title, then by repo name
+projects.sort((a, b) => {
+	const aName = a.data.title ?? a.data.repo.name;
+	const bName = b.data.title ?? b.data.repo.name;
+	return aName.toLowerCase().localeCompare(bName.toLowerCase());
+});
 ---
 
 <BaseLayout isWide>
@@ -48,13 +57,6 @@ orgs.sort((a, b) => a.toLowerCase().localeCompare(b.toLowerCase()));
 		flex-direction: row;
 	}
 
-	/* .projects-sidebar {
-		list-style: none;
-		margin: 0;
-		padding: 0;
-		width: 200px;
-	} */
-
 	.projects-sidebar {
 		font-family: "Space-Grotesk", sans-serif;
 		position: sticky;