Show Play button for workflows with repo_dispatch trigger

cschleiden · cschleiden · commit 13fd241a7ed9 · 2020-04-23T17:31:02.000-07:00
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -74,7 +74,11 @@
       {
         "command": "explorer.triggerRun",
         "title": "Trigger workflow",
-        "when": "viewItem =~ /workflow/ && viewItem =~ /rdispatch/"
+        "when": "viewItem =~ /workflow/ && viewItem =~ /rdispatch/",
+        "icon": {
+          "dark": "resources/icons/dark/run.svg",
+          "light": "resources/icons/light/run.svg"
+        }
       },
       {
         "command": "workflow.run.open",
@@ -154,6 +158,13 @@
           "when": "view == workflows || view == settings"
         }
       ],
+      "editor/title": [
+        {
+          "command": "explorer.triggerRun",
+          "when": "githubActions:activeFile =~ /rdispatch/ && resourceExtname =~ /\\.ya?ml/",
+          "group": "navigation"
+        }
+      ],
       "view/item/context": [
         {
           "command": "explorer.openWorkflowFile",
diff --git a/resources/icons/dark/run.svg b/resources/icons/dark/run.svg
@@ -0,0 +1,3 @@
+<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M4 2V14.4805L12.9146 8.24024L4 2ZM11.1809 8.24024L4.995 12.5684V3.91209L11.1809 8.24024Z" fill="#C5C5C5"/>
+</svg>
diff --git a/resources/icons/light/run.svg b/resources/icons/light/run.svg
@@ -0,0 +1,3 @@
+<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg">
+<path fill-rule="evenodd" clip-rule="evenodd" d="M4 2V14.4805L12.9146 8.24024L4 2ZM11.1809 8.24024L4.995 12.5684V3.91209L11.1809 8.24024Z" fill="#424242"/>
+</svg>
diff --git a/src/extension.ts b/src/extension.ts
@@ -1,9 +1,10 @@
 import { Octokit } from "@octokit/rest";
 import * as vscode from "vscode";
 import { setPAT } from "./auth/pat";
+import { getClient } from "./client/client";
 import { initConfiguration } from "./configuration/configuration";
 import { Protocol } from "./external/protocol";
-import { getGitHubUrl } from "./git/repository";
+import { getGitHubProtocol, getGitHubUrl } from "./git/repository";
 import { LogScheme } from "./logs/constants";
 import { WorkflowStepLogProvider } from "./logs/fileProvider";
 import { WorkflowStepLogFoldingProvider } from "./logs/foldingProvider";
@@ -20,6 +21,7 @@ import {
 } from "./model";
 import { initPinnedWorkflows } from "./pinnedWorkflows/pinnedWorkflows";
 import { encodeSecret } from "./secrets";
+import { initWorkflowDocumentTracking } from "./tracker/workflowDocumentTracker";
 import { initResources } from "./treeViews/icons";
 import { SettingsTreeProvider } from "./treeViews/settings";
 import { ActionsExplorerProvider as WorkflowsTreeProvider } from "./treeViews/workflows";
@@ -37,6 +39,9 @@ export function activate(context: vscode.ExtensionContext) {
   initConfiguration(context);
   initPinnedWorkflows(context);
 
+  // Track workflow
+  initWorkflowDocumentTracking(context);
+
   // Actions Explorer
   const workflowTreeProvider = new WorkflowsTreeProvider();
   context.subscriptions.push(
@@ -83,8 +88,15 @@ export function activate(context: vscode.ExtensionContext) {
     vscode.commands.registerCommand("explorer.triggerRun", async (args) => {
       let event_type: string | undefined;
 
+      let workflowUri: vscode.Uri | null = null;
+
       const wf: Workflow = args.wf;
-      const workflowUri = getWorkflowUri(wf.path);
+      if (wf) {
+        workflowUri = getWorkflowUri(wf.path);
+      } else if (args.fsPath) {
+        workflowUri = args;
+      }
+
       if (!workflowUri) {
         return;
       }
@@ -114,8 +126,8 @@ export function activate(context: vscode.ExtensionContext) {
       }
 
       if (event_type) {
-        const repo: Protocol = args.repo;
-        const client: Octokit = args.client;
+        const repo: Protocol = args.repo || (await getGitHubProtocol());
+        const client: Octokit = args.client || (await getClient());
 
         await client.repos.createDispatchEvent({
           owner: repo.owner,
diff --git a/src/tracker/workflowDocumentTracker.ts b/src/tracker/workflowDocumentTracker.ts
@@ -0,0 +1,48 @@
+import { extname } from "path";
+import * as vscode from "vscode";
+import { usesRepositoryDispatch } from "../workflow/workflow";
+
+export function initWorkflowDocumentTracking(context: vscode.ExtensionContext) {
+  context.subscriptions.push(
+    vscode.window.onDidChangeActiveTextEditor(onDidChangeActiveTextEditor)
+  );
+
+  // Check for initial document
+  onDidChangeActiveTextEditor(vscode.window.activeTextEditor);
+}
+
+function onDidChangeActiveTextEditor(editor?: vscode.TextEditor) {
+  if (!editor || !isTextEditor(editor)) {
+    return;
+  }
+
+  // Check if the file is saved and could be a workflow
+  if (
+    !editor.document.uri?.fsPath ||
+    editor.document.uri.scheme !== "file" ||
+    (extname(editor.document.fileName) !== ".yaml" &&
+      extname(editor.document.fileName) !== ".yml") ||
+    editor.document.fileName.indexOf(".github/workflows") === -1
+  ) {
+    return;
+  }
+
+  vscode.commands.executeCommand(
+    "setContext",
+    "githubActions:activeFile",
+    usesRepositoryDispatch(editor.document.uri.fsPath) ? "rdispatch" : ""
+  );
+}
+
+// Adapted from from https://github.com/eamodio/vscode-gitlens/blob/f22a9cd4199ac498c217643282a6a412e1fc01ae/src/constants.ts#L74
+enum DocumentSchemes {
+  DebugConsole = "debug",
+  Output = "output",
+}
+
+function isTextEditor(editor: vscode.TextEditor): boolean {
+  const scheme = editor.document.uri.scheme;
+  return (
+    scheme !== DocumentSchemes.Output && scheme !== DocumentSchemes.DebugConsole
+  );
+}
