Add only option

.github/workflows/metrics.yml

@@ -11,3 +11,5 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./
+        with:
+          only: ci.yml

action.yml

@@ -1,6 +1,10 @@
 name: GitHub Workflow Metrics
 description: TODO
 inputs:
+  only:
+    description: Only the specified workflows will be measured. This is supposed to be comma-separated list
+    required: false
+    default: ""
   label:
     description: The label for GitHub issues that the GitHub Action creates
     required: false

dist/index.js

@@ -29241,8 +29241,14 @@ class GitHubRepository {
         this.repo = repo;
         this.apiClient = apiClient;
     }
-    async getWorkflows() {
-        return this.apiClient.getWorkflows(this.owner, this.repo);
+    async getWorkflows(only) {
+        const workflows = await this.apiClient.getWorkflows(this.owner, this.repo);
+        if (only) {
+            return workflows.filter((w) => {
+                return only.some((o) => w.path.endsWith(o));
+            });
+        }
+        return workflows;
     }
     async getWorkflow(path) {
         return this.apiClient.getWorkflow(this.owner, this.repo, path);
@@ -29280,6 +29286,13 @@ class Input {
     get label() {
         return this.getInputFn("label");
     }
+    get only() {
+        const only = this.getInputFn("only");
+        if (only.length === 0) {
+            return null;
+        }
+        return only.split(/\s*,\s*/);
+    }
     get token() {
         return this.getInputFn("token", { required: true });
     }
@@ -29328,7 +29341,7 @@ const main = async () => {
     const input = new Input();
     const apiClient = new GitHubAPIClient(input.token);
     const repository = new GitHubRepository(input.owner, input.repo, apiClient);
-    const workflows = await repository.getWorkflows();
+    const workflows = await repository.getWorkflows(input.only);
     const charts = await Promise.all(workflows.map(async (w) => {
         const runs = await repository.getWorkflowRuns(w);
         return new MermaidXYChart(w, runs);

src/GitHubRepository.ts

@@ -11,8 +11,14 @@ export class GitHubRepository {
 		private readonly apiClient: APIClient,
 	) {}
 
-	async getWorkflows(): Promise<GitHubWorkflow[]> {
-		return this.apiClient.getWorkflows(this.owner, this.repo);
+	async getWorkflows(only?: string[] | null): Promise<GitHubWorkflow[]> {
+		const workflows = await this.apiClient.getWorkflows(this.owner, this.repo);
+		if (only) {
+			return workflows.filter((w) => {
+				return only.some((o) => w.path.endsWith(o));
+			});
+		}
+		return workflows;
 	}
 
 	async getWorkflow(path: string): Promise<GitHubWorkflow> {

src/Input.ts

@@ -23,6 +23,14 @@ export class Input {
 		return this.getInputFn("label");
 	}
 
+	get only(): string[] | null {
+		const only = this.getInputFn("only");
+		if (only.length === 0) {
+			return null;
+		}
+		return only.split(/\s*,\s*/);
+	}
+
 	get token(): string {
 		return this.getInputFn("token", { required: true });
 	}

src/TestClient.ts

@@ -7,7 +7,10 @@ import { GitHubWorkflowRun } from "./GitHubWorkflowRun";
 
 export class TestClient implements APIClient {
 	async getWorkflows(_owner: string, _repo: string): Promise<GitHubWorkflow[]> {
-		return [new GitHubWorkflow(1234, "My Workflow", "my_workflow.yml")];
+		return [
+			new GitHubWorkflow(1234, "My Workflow", "my_workflow.yml"),
+			new GitHubWorkflow(1235, "XYZ", "xyz.yml"),
+		];
 	}
 	async getWorkflow(
 		_owner: string,

src/main.ts

@@ -9,7 +9,7 @@ const main = async () => {
 	const input = new Input();
 	const apiClient = new GitHubAPIClient(input.token);
 	const repository = new GitHubRepository(input.owner, input.repo, apiClient);
-	const workflows = await repository.getWorkflows();
+	const workflows = await repository.getWorkflows(input.only);
 	const charts = await Promise.all(
 		workflows.map(async (w) => {
 			const runs = await repository.getWorkflowRuns(w);

tests/GitHubRepository.test.ts

@@ -1,20 +1,22 @@
-import { describe, it } from "vitest";
+import { describe, expect, it } from "vitest";
 import { GitHubIssue } from "../src/GitHubIssue";
 import { GitHubIssueContent } from "../src/GitHubIssueContent";
 import { GitHubRepository } from "../src/GitHubRepository";
 import { GitHubWorkflow } from "../src/GitHubWorkflow";
 import { TestClient } from "../src/TestClient";
 
 describe("GitHubRepository", () => {
-	it("should call functions declared in APIClient", () => {
+	it("should call functions declared in APIClient", async () => {
 		const client = new TestClient();
 		const repository = new GitHubRepository("owner", "repo", client);
-		repository.getWorkflows();
-		repository.getWorkflow("abc.yml");
-		repository.getWorkflowRuns(new GitHubWorkflow(8, "Eight", "eight.yml"));
-		repository.getIssues([]);
-		repository.createIssue(new GitHubIssueContent([], "title"));
-		repository.closeIssue(
+		await repository.getWorkflows();
+		await repository.getWorkflow("abc.yml");
+		await repository.getWorkflowRuns(
+			new GitHubWorkflow(8, "Eight", "eight.yml"),
+		);
+		await repository.getIssues([]);
+		await repository.createIssue(new GitHubIssueContent([], "title"));
+		await repository.closeIssue(
 			new GitHubIssue({
 				id: 1,
 				number: 1,
@@ -25,4 +27,12 @@ describe("GitHubRepository", () => {
 			}),
 		);
 	});
+
+	it("should filter workflows with only", async () => {
+		const client = new TestClient();
+		const repository = new GitHubRepository("owner", "repo", client);
+		const workflows = await repository.getWorkflows(["xyz.yml"]);
+		expect(workflows.length).toEqual(1);
+		expect(workflows.map((w) => w.path)).toEqual(["xyz.yml"]);
+	});
 });

tests/Input.test.ts

@@ -19,6 +19,8 @@ describe("Input", () => {
 					return "my-token";
 				case "label":
 					return "github-workflows-metrics";
+				case "only":
+					return "";
 				default:
 					throw new Error("Unsupported key");
 			}
@@ -27,6 +29,24 @@ describe("Input", () => {
 		expect(input.owner).toEqual("yykamei");
 		expect(input.repo).toEqual("test-repo");
 		expect(input.label).toEqual("github-workflows-metrics");
+		expect(input.only).toBeNull();
 		expect(input.token).toEqual("my-token");
 	});
+	it("should return an Array for only when specified", () => {
+		const context = new Context();
+		vi.spyOn(context, "repo", "get").mockReturnValue({
+			owner: "yykamei",
+			repo: "test-repo",
+		});
+		const getInput = vi.fn((key: string) => {
+			switch (key) {
+				case "only":
+					return "a.yml   , b.yml,c.yml";
+				default:
+					throw new Error("Unsupported key");
+			}
+		});
+		const input = new Input(context, getInput);
+		expect(input.only).toEqual(["a.yml", "b.yml", "c.yml"]);
+	});
 });