Merge pull request #170 from github/ketchup-lrotschy/show-step-logs

Add a globe icon to workflow steps that links to the GitHub.com specific step

Author: KetchupOnMyKetchup

package.json

@@ -140,13 +140,20 @@
       {
         "command": "github-actions.workflow.logs",
         "category": "GitHub Actions",
-        "title": "View logs",
+        "title": "View job logs",
         "when": "viewItem =~ /job/",
         "icon": {
           "dark": "resources/icons/dark/logs.svg",
           "light": "resources/icons/light/logs.svg"
         }
       },
+      {
+        "command": "github-actions.step.logs",
+        "category": "GitHub Actions",
+        "title": "View step logs",
+        "when": "viewItem =~ /step/",
+        "icon": "$(globe)"
+      },
       {
         "command": "github-actions.workflow.run.rerun",
         "category": "GitHub Actions",
@@ -363,6 +370,11 @@
           "group": "inline",
           "when": "viewItem =~ /job/ && viewItem =~ /completed/"
         },
+        {
+          "command": "github-actions.step.logs",
+          "group": "inline",
+          "when": "viewItem =~ /step/ && viewItem =~ /completed/"
+        },
         {
           "command": "github-actions.workflow.run.cancel",
           "when": "viewItem =~ /run/ && viewItem =~ /cancelable/"
@@ -438,6 +450,10 @@
           "command": "github-actions.workflow.logs",
           "when": "false"
         },
+        {
+          "command": "github-actions.step.logs",
+          "when": "false"
+        },
         {
           "command": "github-actions.workflow.run.rerun",
           "when": "false"

src/commands/openWorkflowStepLogs.ts

@@ -0,0 +1,22 @@
+import * as vscode from "vscode";
+import {WorkflowStepNode} from "../treeViews/workflows/workflowStepNode";
+
+type WorkflowStepCommandArgs = Pick<WorkflowStepNode, "job" | "step" | "gitHubRepoContext">;
+
+export function registerOpenWorkflowStepLogs(context: vscode.ExtensionContext) {
+  context.subscriptions.push(
+    vscode.commands.registerCommand("github-actions.step.logs", async (args: WorkflowStepCommandArgs) => {
+      const job = args.job.job;
+      let url = job.html_url ?? "";
+      const stepName = args.step.name;
+
+      const index = job.steps && job.steps.findIndex(step => step.name === stepName) + 1;
+
+      if (url && index) {
+        url = url + "#step:" + index.toString() + ":1";
+      }
+
+      await vscode.env.openExternal(vscode.Uri.parse(url));
+    })
+  );
+}

src/extension.ts

@@ -5,6 +5,7 @@ import {getSession} from "./auth/auth";
 import {registerCancelWorkflowRun} from "./commands/cancelWorkflowRun";
 import {registerOpenWorkflowFile} from "./commands/openWorkflowFile";
 import {registerOpenWorkflowJobLogs} from "./commands/openWorkflowJobLogs";
+import {registerOpenWorkflowStepLogs} from "./commands/openWorkflowStepLogs";
 import {registerOpenWorkflowRun} from "./commands/openWorkflowRun";
 import {registerPinWorkflow} from "./commands/pinWorkflow";
 import {registerReRunWorkflowRun} from "./commands/rerunWorkflowRun";
@@ -71,6 +72,7 @@ export async function activate(context: vscode.ExtensionContext) {
   registerOpenWorkflowRun(context);
   registerOpenWorkflowFile(context);
   registerOpenWorkflowJobLogs(context);
+  registerOpenWorkflowStepLogs(context);
   registerTriggerWorkflowRun(context);
   registerReRunWorkflowRun(context);
   registerCancelWorkflowRun(context);