@theholocron/github-client 1.28.0 → 1.29.0

package/dist/index.d.mts

@@ -39,6 +39,14 @@ interface GitHubCheckRun {
   conclusion: CheckRunConclusion | null;
   html_url: string;
 }
+interface UpdateCheckRunInput {
+  status?: CheckRunStatus;
+  /** Required when `status` is `"completed"`. */
+  conclusion?: CheckRunConclusion;
+  output?: CheckRunOutput;
+  /** URL for the "Details" link on the check run. */
+  details_url?: string;
+}
 //#endregion
 //#region src/environments/environments.d.ts
 interface GitHubEnvironment {
@@ -373,6 +381,7 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
   };
   checks: {
     createCheckRun: (repo: string, input: CreateCheckRunInput) => Promise<GitHubCheckRun>;
+    updateCheckRun: (repo: string, checkRunId: number, input: UpdateCheckRunInput) => Promise<GitHubCheckRun>;
   };
   environments: {
     listEnvironments: (repo: string) => Promise<GitHubEnvironment[]>;
@@ -471,8 +480,9 @@ declare function createGitHubClient(opts: GitHubClientOptions): {
   workflows: {
     listRuns: (repo: string, filter?: WorkflowRunFilter) => Promise<GitHubWorkflowRun[]>;
     getRun: (repo: string, id: string | number) => Promise<GitHubWorkflowRun>;
+    createWorkflowDispatch: (repo: string, workflowFile: string, ref: string, inputs?: Record<string, string>) => Promise<void>;
   };
 };
 type GitHubClient = ReturnType<typeof createGitHubClient>;
 //#endregion
-export { type CheckRunConclusion, type CheckRunOutput, type CheckRunStatus, type CodeScanningSetupResult, type CreateCheckRunInput, type CreatePagesPayload, type CreatePullInput, type GitBlob, type GitCommit, type GitContents, type GitHubAppCredentials, type GitHubCheckRun, GitHubClient, type GitHubClientOptions, type GitHubContents, type GitHubEnvironment, type GitHubInstallationWebhookPayload, type GitHubIssue, type GitHubLabel, type GitHubMilestone, type GitHubPages, type GitHubPublicKey, type GitHubPullRequest, type GitHubPullRequestCommit, type GitHubPullRequestFile, type GitHubPullRequestWebhookPayload, type GitHubPushWebhookPayload, type GitHubRepo, type GitHubRuleset, type GitHubUser, type GitHubWebhookHeaders, type GitHubWorkflowRun, type GitPull, type GitRef, type GitTree, type GitTreeItem, type InstallationAccessToken, type IssueSearchParams, type PagesBuildStatus, type PagesBuildType, type SecretScope, type TeamPermission, type UpdatePagesPayload, type WorkflowRunFilter, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };
+export { type CheckRunConclusion, type CheckRunOutput, type CheckRunStatus, type CodeScanningSetupResult, type CreateCheckRunInput, type CreatePagesPayload, type CreatePullInput, type GitBlob, type GitCommit, type GitContents, type GitHubAppCredentials, type GitHubCheckRun, GitHubClient, type GitHubClientOptions, type GitHubContents, type GitHubEnvironment, type GitHubInstallationWebhookPayload, type GitHubIssue, type GitHubLabel, type GitHubMilestone, type GitHubPages, type GitHubPublicKey, type GitHubPullRequest, type GitHubPullRequestCommit, type GitHubPullRequestFile, type GitHubPullRequestWebhookPayload, type GitHubPushWebhookPayload, type GitHubRepo, type GitHubRuleset, type GitHubUser, type GitHubWebhookHeaders, type GitHubWorkflowRun, type GitPull, type GitRef, type GitTree, type GitTreeItem, type InstallationAccessToken, type IssueSearchParams, type PagesBuildStatus, type PagesBuildType, type SecretScope, type TeamPermission, type UpdateCheckRunInput, type UpdatePagesPayload, type WorkflowRunFilter, createAppJWT, createGitHubClient, createInstallationClient, getInstallationAccessToken, parseGitHubWebhookHeaders, verifyGitHubWebhookSignature };

package/dist/index.mjs

@@ -31,10 +31,17 @@ function branches(rest) {
 //#endregion
 //#region src/checks/checks.ts
 function checks(rest) {
-	return { createCheckRun: (repo, input) => rest.request(`${repoBase(repo)}/check-runs`, {
-		method: "POST",
-		body: input
-	}) };
+	return {
+		createCheckRun: (repo, input) => rest.request(`${repoBase(repo)}/check-runs`, {
+			method: "POST",
+			body: input
+		}),
+		/** Patches an existing check run — used to move a `"queued"` run posted before a dispatched task ran to `"completed"` once it finishes. */
+		updateCheckRun: (repo, checkRunId, input) => rest.request(`${repoBase(repo)}/check-runs/${checkRunId}`, {
+			method: "PATCH",
+			body: input
+		})
+	};
 }
 //#endregion
 //#region src/environments/environments.ts
@@ -365,7 +372,23 @@ function workflows(rest) {
 			const path = qs ? `${repoBase(repo)}/actions/runs?${qs}` : `${repoBase(repo)}/actions/runs`;
 			return rest.request(path).then((r) => r.workflow_runs);
 		},
-		getRun: (repo, id) => rest.request(`${repoBase(repo)}/actions/runs/${id}`)
+		getRun: (repo, id) => rest.request(`${repoBase(repo)}/actions/runs/${id}`),
+		/**
+		* Triggers a `workflow_dispatch` run. `workflowFile` is the workflow's
+		* filename (e.g. `"platform.dispatchedCheck.yml"`) — GitHub accepts the
+		* filename directly, no numeric workflow ID lookup needed. Fire-and-forget:
+		* the API returns `204` with no run ID, so callers needing to correlate
+		* the resulting run back to this call must pass their own correlation
+		* value through `inputs` (visible in the Actions UI/logs — never a secret).
+		*/
+		createWorkflowDispatch: (repo, workflowFile, ref, inputs) => rest.request(`${repoBase(repo)}/actions/workflows/${workflowFile}/dispatches`, {
+			method: "POST",
+			body: {
+				ref,
+				inputs
+			},
+			expectNoContent: true
+		})
 	};
 }
 //#endregion

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/github-client",
-  "version": "1.28.0",
+  "version": "1.29.0",
   "description": "A TypeScript client for the GitHub REST API",
   "keywords": [
     "github",
@@ -33,7 +33,7 @@
   ],
   "dependencies": {
     "@theholocron/observability": "^0.3.0",
-    "@theholocron/http-client": "^1.28.0"
+    "@theholocron/http-client": "^1.29.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.33",