Provide links to open actions on GitHub

2022-12-21 13:34:10 +01:00
parent 3bc0cb0b4e
commit 56e8393e0f
6 changed files with 146 additions and 7 deletions
@@ -0,0 +1,51 @@
+import {convertWorkflowTemplate, parseWorkflow} from "@github/actions-workflow-parser";
+import {ErrorPolicy} from "@github/actions-workflow-parser/model/convert";
+import {File} from "@github/actions-workflow-parser/workflows/file";
+import {TextDocument} from "vscode-languageserver-textdocument";
+import {DocumentLink} from "vscode-languageserver-types";
+import {parseActionReference} from "./action";
+import {nullTrace} from "./nulltrace";
+import {mapRange} from "./utils/range";
+
+export async function documentLinks(document: TextDocument): Promise<DocumentLink[] | null> {
+  const file: File = {
+    name: document.uri,
+    content: document.getText()
+  };
+
+  const result = parseWorkflow(file.name, [file], nullTrace);
+  if (!result.value) {
+    return [];
+  }
+
+  const template = convertWorkflowTemplate(result.context, result.value!, ErrorPolicy.TryConversion);
+
+  // Add links to referenced actions
+  const actionLinks: DocumentLink[] = [];
+
+  // TODO: Support base uri for GHES
+  const gitHubBaseUri = "https://www.github.com/";
+
+  for (const job of template?.jobs || []) {
+    for (const step of job?.steps || []) {
+      if ("uses" in step) {
+        const actionRef = parseActionReference(step.uses.value);
+        if (!actionRef) {
+          continue;
+        }
+
+        const url = `${gitHubBaseUri}${actionRef.owner}/${actionRef.name}/tree/${actionRef.ref}/${
+          actionRef.path || ""
+        }`;
+
+        actionLinks.push({
+          range: mapRange(step.uses.range),
+          target: url,
+          tooltip: `Open action on GitHub`
+        });
+      }
+    }
+  }
+
+  return [...actionLinks];
+}