Merge branch 'copilot/add-includes-option-and-counter-update'

Author: Daraan

action.yml

@@ -1,5 +1,5 @@
-name: GitHub Readme Stats Action
-description: Generate GitHub Readme Stats cards in GitHub Actions.
+name: GitHub PR Stats Action
+description: Generate stat card images about merged PR in GitHub Actions (aggregated by organization).
 author: readme-tools
 inputs:
   card:
@@ -58,6 +58,10 @@ inputs:
     description: Comma-separated repo name substrings to exclude. Overrides `exclude` in options.
     required: false
     default: ""
+  includes:
+    description: Comma-separated "owner/repo" names to always include, even if they have no merged PRs or are forks. Overrides `includes` in options.
+    required: false
+    default: ""
   custom_images:
     description: >
       Custom image URLs for specific repositories, overriding the default owner
@@ -104,6 +108,7 @@ runs:
         INPUT_HIDE_BORDER: ${{ inputs.hide_border }}
         INPUT_BORDER_RADIUS: ${{ inputs.border_radius }}
         INPUT_EXCLUDE: ${{ inputs.exclude }}
+        INPUT_INCLUDES: ${{ inputs.includes }}
 branding:
   icon: bar-chart-2
   color: blue

index.js

@@ -1,7 +1,13 @@
 import core from "@actions/core";
 import { mkdir, writeFile, readFile } from "node:fs/promises";
 import path from "node:path";
-import { fetchUserPRs, renderOrgCard, parseExcludeList, parseCustomImages } from "./prs.js";
+import {
+  fetchUserPRs,
+  renderOrgCard,
+  parseExcludeList,
+  parseIncludeList,
+  parseCustomImages,
+} from "./prs.js";
 
 /**
  * Normalize option values to strings.
@@ -68,6 +74,7 @@ const OPTION_KEYS = [
   "hide_border",
   "border_radius",
   "exclude",
+  "includes",
 ];
 
 /**
@@ -116,8 +123,16 @@ const run = async () => {
     }
 
     const excludeList = parseExcludeList(query.exclude);
-    const customImages = parseCustomImages(core.getInput("custom_images") || "");
-    const result = await fetchUserPRs(query.username, token, excludeList);
+    const includeList = parseIncludeList(query.includes);
+    const customImages = parseCustomImages(
+      core.getInput("custom_images") || "",
+    );
+    const result = await fetchUserPRs(
+      query.username,
+      token,
+      excludeList,
+      includeList,
+    );
 
     const allOrgs = [...result.external, ...result.own];
 
@@ -150,7 +165,12 @@ const run = async () => {
       const rawName = orgData.repo ? orgData.repo : orgData.org;
       const safeName = rawName.replace(/[^a-zA-Z0-9._-]/g, "-");
       const filePath = path.join(baseDir, `${prefix}${safeName}.svg`);
-      const svg = await renderOrgCard(orgData, query, languageColors, customImages);
+      const svg = await renderOrgCard(
+        orgData,
+        query,
+        languageColors,
+        customImages,
+      );
       await writeFile(filePath, svg, "utf8");
       core.info(`Wrote ${filePath}`);
       written.push(path.relative(process.cwd(), filePath));
@@ -161,7 +181,12 @@ const run = async () => {
       const rawName = ownData.repo ? ownData.repo : ownData.org;
       const safeName = rawName.replace(/[^a-zA-Z0-9._-]/g, "-");
       const filePath = path.join(baseDir, `${prefix}own-${safeName}.svg`);
-      const svg = await renderOrgCard(ownData, query, languageColors, customImages);
+      const svg = await renderOrgCard(
+        ownData,
+        query,
+        languageColors,
+        customImages,
+      );
       await writeFile(filePath, svg, "utf8");
       core.info(`Wrote ${filePath}`);
       written.push(path.relative(process.cwd(), filePath));

prs.js

@@ -109,6 +109,19 @@ const parseExcludeList = (value) => {
     .filter(Boolean);
 };
 
+/**
+ * Parse a comma-separated include list of repository names ("owner/repo").
+ * @param {string | undefined} value
+ * @returns {string[]}
+ */
+const parseIncludeList = (value) => {
+  if (!value) return [];
+  return value
+    .split(",")
+    .map((entry) => entry.trim())
+    .filter(Boolean);
+};
+
 /**
  * Check if a repository name should be excluded.
  * @param {string} repoName
@@ -149,6 +162,23 @@ const resolveOrgDisplayName = (ownerType, orgDisplayName, repoName) => {
 // GitHub GraphQL fetcher
 // ---------------------------------------------------------------------------
 
+const REPO_INFO_QUERY = `
+  query($owner: String!, $name: String!) {
+    repository(owner: $owner, name: $name) {
+      nameWithOwner
+      isFork
+      owner {
+        __typename
+        login
+        avatarUrl
+        ... on Organization { name }
+      }
+      stargazerCount
+      primaryLanguage { name }
+    }
+  }
+`;
+
 const SEARCH_MERGED_PRS_QUERY = `
   query($searchQuery: String!, $after: String) {
     search(query: $searchQuery, type: ISSUE, first: 100, after: $after) {
@@ -188,9 +218,15 @@ const SEARCH_MERGED_PRS_QUERY = `
  * @param {string} username GitHub username.
  * @param {string} token GitHub PAT.
  * @param {string[]} [excludeList] List of repo name substrings to skip.
+ * @param {string[]} [includeList] List of "owner/repo" names to always include.
  * @returns {Promise<UserPRsResult>} Aggregated PR data separated by external and own repos.
  */
-const fetchUserPRs = async (username, token, excludeList = []) => {
+const fetchUserPRs = async (
+  username,
+  token,
+  excludeList = [],
+  includeList = [],
+) => {
   const headers = {
     Authorization: `bearer ${token}`,
     "Content-Type": "application/json",
@@ -333,6 +369,80 @@ const fetchUserPRs = async (username, token, excludeList = []) => {
   // Sort own repos descending by merged PRs to mirror external ordering.
   ownResult.sort((a, b) => b.mergedPRs - a.mergedPRs);
 
+  // Process forced-include repos that may have no merged PRs or be forks.
+  for (const includeRepo of includeList) {
+    const slashIdx = includeRepo.indexOf("/");
+    if (slashIdx === -1) continue;
+    const owner = includeRepo.slice(0, slashIdx);
+    const name = includeRepo.slice(slashIdx + 1);
+    if (!owner || !name) continue;
+    const fullName = `${owner}/${name}`;
+    const fullNameLower = fullName.toLowerCase();
+
+    // Skip if already in results.
+    const alreadyExternal = externalResult.some(
+      (e) => e.repo.toLowerCase() === fullNameLower,
+    );
+    const alreadyOwn = ownResult.some(
+      (e) => e.repo.toLowerCase() === fullNameLower,
+    );
+    if (alreadyExternal || alreadyOwn) continue;
+
+    // Fetch repo info from GitHub.
+    let repoNode;
+    try {
+      const res = await fetch("https://api.github.com/graphql", {
+        method: "POST",
+        headers,
+        body: JSON.stringify({
+          query: REPO_INFO_QUERY,
+          variables: { owner, name },
+        }),
+      });
+      if (!res.ok) {
+        console.warn(
+          `Could not fetch included repository ${fullName}: HTTP ${res.status}`,
+        );
+        continue;
+      }
+      const json = await res.json();
+      repoNode = json.data?.repository;
+      if (!repoNode) {
+        console.warn(
+          `Included repository ${fullName} was not found on GitHub.`,
+        );
+      }
+    } catch (err) {
+      console.warn(`Failed to fetch included repository ${fullName}: ${err}`);
+      continue;
+    }
+    if (!repoNode) continue;
+
+    const ownerLogin = repoNode.owner.login;
+    const ownerType = repoNode.owner.__typename || "User";
+    const displayName = resolveOrgDisplayName(
+      ownerType,
+      repoNode.owner.name || ownerLogin,
+      repoNode.nameWithOwner,
+    );
+
+    const entry = {
+      org: ownerLogin,
+      orgDisplayName: displayName,
+      avatarUrl: repoNode.owner.avatarUrl,
+      repo: repoNode.nameWithOwner,
+      stars: repoNode.stargazerCount,
+      mergedPRs: 0,
+      language: repoNode.primaryLanguage?.name || "",
+    };
+
+    if (ownerLogin.toLowerCase() === username.toLowerCase()) {
+      ownResult.push(entry);
+    } else {
+      externalResult.push(entry);
+    }
+  }
+
   return {
     external: externalResult,
     own: ownResult,
@@ -502,6 +612,14 @@ const renderOrgCard = async (
     return String(n);
   };
 
+  const mergedPRsSvg =
+    data.mergedPRs > 0
+      ? `<g transform="translate(80, 0)">
+      ${mergedIcon}
+      <text x="20" y="13" class="stat">${data.mergedPRs} merged</text>
+    </g>`
+      : "";
+
   const svg = `<svg
   width="${width}" height="${height}"
   viewBox="0 0 ${width} ${height}"
@@ -541,10 +659,7 @@ const renderOrgCard = async (
       ${starIcon}
       <text x="20" y="13" class="stat">${formatCount(data.stars)}</text>
     </g>
-    <g transform="translate(80, 0)">
-      ${mergedIcon}
-      <text x="20" y="13" class="stat">${data.mergedPRs} merged</text>
-    </g>
+    ${mergedPRsSvg}
   </g>
 </svg>`;
 
@@ -577,6 +692,7 @@ export {
   LANG_ICON_SLUGS,
   parseCustomImages,
   parseExcludeList,
+  parseIncludeList,
   shouldExcludeRepo,
   getRepoShortName,
   resolveOrgDisplayName,