Add workflow run deletion action

package.json

@@ -188,6 +188,13 @@
         "title": "Cancel workflow run",
         "when": "viewItem =~ /run/ && viewItem =~ /cancelable/"
       },
+      {
+        "command": "github-actions.workflow.run.delete",
+        "category": "GitHub Actions",
+        "title": "Delete workflow run",
+        "when": "viewItem =~ /run/ && viewItem =~ /deletable/",
+        "icon": "$(trash)"
+      },
       {
         "command": "github-actions.settings.secrets.manage",
         "category": "GitHub Actions",
@@ -405,6 +412,11 @@
           "command": "github-actions.workflow.run.rerun",
           "when": "viewItem =~ /run/ && viewItem =~ /rerunnable/"
         },
+        {
+          "command": "github-actions.workflow.run.delete",
+          "when": "viewItem =~ /run/ && viewItem =~ /deletable/",
+          "group": "inline@3"
+        },
         {
           "command": "github-actions.settings.secret.add",
           "group": "inline",
@@ -484,6 +496,10 @@
           "command": "github-actions.workflow.run.cancel",
           "when": "false"
         },
+        {
+          "command": "github-actions.workflow.run.delete",
+          "when": "false"
+        },
         {
           "command": "github-actions.settings.secrets.manage",
           "when": "false"

src/commands/deleteWorkflowRun.ts

@@ -0,0 +1,39 @@
+import * as vscode from "vscode";
+import {WorkflowRunCommandArgs} from "../treeViews/shared/workflowRunNode";
+
+export function registerDeleteWorkflowRun(context: vscode.ExtensionContext) {
+  context.subscriptions.push(
+    vscode.commands.registerCommand("github-actions.workflow.run.delete", async (args: WorkflowRunCommandArgs) => {
+      const {gitHubRepoContext, run} = args;
+      const acceptText = "Yes, delete this workflow run";
+      const answer = await vscode.window.showWarningMessage(
+        `Are you sure you want to delete workflow run #${run.run.run_number}?`,
+        {
+          modal: true,
+          detail: "Deleting this workflow run, its logs, and its artifacts cannot be undone"
+        },
+        acceptText
+      );
+
+      if (answer !== acceptText) {
+        return;
+      }
+
+      try {
+        await gitHubRepoContext.client.actions.deleteWorkflowRun({
+          owner: gitHubRepoContext.owner,
+          repo: gitHubRepoContext.name,
+          run_id: run.run.id
+        });
+      } catch (e) {
+        await vscode.window.showErrorMessage(`Could not delete workflow run: '${(e as Error).message}'`);
+        return;
+      }
+
+      await Promise.all([
+        vscode.commands.executeCommand("github-actions.explorer.refresh"),
+        vscode.commands.executeCommand("github-actions.explorer.current-branch.refresh")
+      ]);
+    })
+  );
+}

src/extension.ts

@@ -3,6 +3,7 @@ import * as vscode from "vscode";
 import {canReachGitHubAPI} from "./api/canReachGitHubAPI";
 import {getSession} from "./auth/auth";
 import {registerCancelWorkflowRun} from "./commands/cancelWorkflowRun";
+import {registerDeleteWorkflowRun} from "./commands/deleteWorkflowRun";
 import {registerOpenWorkflowFile} from "./commands/openWorkflowFile";
 import {registerOpenWorkflowJobLogs} from "./commands/openWorkflowJobLogs";
 import {registerOpenWorkflowStepLogs} from "./commands/openWorkflowStepLogs";
@@ -78,6 +79,7 @@ export async function activate(context: vscode.ExtensionContext) {
   registerTriggerWorkflowRun(context);
   registerReRunWorkflowRun(context);
   registerCancelWorkflowRun(context);
+  registerDeleteWorkflowRun(context);
 
   registerAddSecret(context);
   registerDeleteSecret(context);

src/store/workflowRun.ts

@@ -1,9 +1,10 @@
 import * as vscode from "vscode";
 import {GitHubRepoContext} from "../git/repository";
-import {RepositoryPermission, hasWritePermission} from "../git/repository-permissions";
+import {RepositoryPermission} from "../git/repository-permissions";
 import {log, logDebug} from "../log";
 import * as model from "../model";
 import {WorkflowJob} from "./WorkflowJob";
+import {getWorkflowRunContextValue} from "./workflowRunContext";
 
 abstract class WorkflowRunBase {
   protected _gitHubRepoContext: GitHubRepoContext;
@@ -53,15 +54,7 @@ abstract class WorkflowRunBase {
   }
 
   contextValue(permission: RepositoryPermission): string {
-    const contextValues = ["run"];
-    const completed = this._run.status === "completed";
-    if (hasWritePermission(permission)) {
-      contextValues.push(completed ? "rerunnable" : "cancelable");
-    }
-    if (completed) {
-      contextValues.push("completed");
-    }
-    return contextValues.join(" ");
+    return getWorkflowRunContextValue(this._run.status, permission);
   }
 
   protected abstract fetchJobs(): Promise<WorkflowJob[]>;

src/store/workflowRunContext.test.ts

@@ -0,0 +1,12 @@
+import {getWorkflowRunContextValue} from "./workflowRunContext";
+
+describe("getWorkflowRunContextValue", () => {
+  it.each([
+    ["read", "completed", "run completed"],
+    ["write", "queued", "run cancelable"],
+    ["write", "completed", "run rerunnable deletable completed"],
+    ["admin", "completed", "run rerunnable deletable completed"]
+  ] as const)("returns the available actions for %s access to a %s run", (permission, status, expected) => {
+    expect(getWorkflowRunContextValue(status, permission)).toBe(expected);
+  });
+});

src/store/workflowRunContext.ts

@@ -0,0 +1,19 @@
+import {RepositoryPermission, hasWritePermission} from "../git/repository-permissions";
+
+export function getWorkflowRunContextValue(status: string | null, permission: RepositoryPermission): string {
+  const contextValues = ["run"];
+  const completed = status === "completed";
+
+  if (hasWritePermission(permission)) {
+    contextValues.push(completed ? "rerunnable" : "cancelable");
+    if (completed) {
+      contextValues.push("deletable");
+    }
+  }
+
+  if (completed) {
+    contextValues.push("completed");
+  }
+
+  return contextValues.join(" ");
+}