Merge branch 'main' into thyeggman/cache-workflow-results

browser-playground/package.json

@@ -1,12 +1,12 @@
 {
   "name": "browser-playground",
-  "version": "0.1.155",
+  "version": "0.1.157",
   "description": "",
   "private": true,
   "main": "index.js",
   "type": "module",
   "dependencies": {
-    "@github/actions-languageserver": "^0.1.155",
+    "@github/actions-languageserver": "^0.1.157",
     "monaco-editor-webpack-plugin": "^7.0.1",
     "monaco-editor-workers": "^0.34.2",
     "monaco-languageclient": "^4.0.3",

expressions/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@github/actions-expressions",
-  "version": "0.1.155",
+  "version": "0.1.157",
   "license": "MIT",
   "type": "module",
   "source": "./src/index.ts",

languageserver/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@github/actions-languageserver",
-  "version": "0.1.155",
+  "version": "0.1.157",
   "description": "Language server for GitHub Actions",
   "license": "MIT",
   "type": "module",
@@ -38,8 +38,8 @@
     "watch": "tsc --build tsconfig.build.json --watch"
   },
   "dependencies": {
-    "@github/actions-languageservice": "^0.1.155",
+    "@github/actions-languageservice": "^0.1.157",
-    "@github/actions-workflow-parser": "^0.1.155",
+    "@github/actions-workflow-parser": "^0.1.157",
     "@octokit/rest": "^19.0.7",
     "vscode-languageserver": "^8.0.2",
     "vscode-languageserver-textdocument": "^1.0.7",

languageserver/src/description-provider.ts

@@ -2,17 +2,22 @@ import {DescriptionProvider} from "@github/actions-languageservice/hover";
 import {Octokit} from "@octokit/rest";
 import {getActionInputDescription} from "./description-providers/action-input";
 import {TTLCache} from "./utils/cache";
+import {getActionDescription} from "./description-providers/action-description";
 
 export function descriptionProvider(client: Octokit | undefined, cache: TTLCache): DescriptionProvider {
   const getDescription: DescriptionProvider["getDescription"] = async (context, token, path) => {
-    if (!client) {
+    if (!client || !context.step) {
       return undefined;
     }
 
     const parent = path[path.length - 1];
-    if (context.step && parent.definition?.key === "step-with") {
+    if (parent.definition?.key === "step-with") {
       return await getActionInputDescription(client, cache, context.step, token);
     }
+
+    if (parent.definition?.key === "step-uses") {
+      return await getActionDescription(client, cache, context.step);
+    }
   };
 
   return {

languageserver/src/description-providers/action-description.test.ts

@@ -0,0 +1,59 @@
+import {Octokit} from "@octokit/rest";
+import fetchMock from "fetch-mock";
+import {createWorkflowContext} from "../test-utils/workflow-context";
+import {TTLCache} from "../utils/cache";
+import {getActionDescription} from "./action-description";
+import {actionsCheckoutMetadata} from "../test-utils/action-metadata";
+
+const workflow = `
+name: Hello World
+on: workflow_dispatch
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+`;
+
+async function getDescription(mock: fetchMock.FetchMockSandbox) {
+  const workflowContext = await createWorkflowContext(workflow, "build", 0);
+
+  return await getActionDescription(
+    new Octokit({
+      request: {
+        fetch: mock
+      }
+    }),
+    new TTLCache(),
+    workflowContext.step!
+  );
+}
+
+describe("action descriptions", () => {
+  it("actions/checkout description", async () => {
+    const mock = fetchMock
+      .sandbox()
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionsCheckoutMetadata);
+
+    expect(await getDescription(mock)).toEqual(
+      "[**Checkout**](https://www.github.com/actions/checkout/tree/v3/)\n\nCheckout a Git repository at a particular version"
+    );
+  });
+
+  it("action does not exist", async () => {
+    const mock = fetchMock
+      .sandbox()
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", 404)
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yaml?ref=v3", 404);
+
+    expect(await getDescription(mock)).toBeUndefined();
+  });
+
+  it("invalid metadata", async () => {
+    const mock = fetchMock
+      .sandbox()
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", {});
+
+    expect(await getDescription(mock)).toBeUndefined();
+  });
+});

languageserver/src/description-providers/action-description.ts

@@ -0,0 +1,23 @@
+import {actionUrl, parseActionReference} from "@github/actions-languageservice/action";
+import {isActionStep} from "@github/actions-workflow-parser/model/type-guards";
+import {Step} from "@github/actions-workflow-parser/model/workflow-template";
+import {Octokit} from "@octokit/rest";
+import {fetchActionMetadata} from "../utils/action-metadata";
+import {TTLCache} from "../utils/cache";
+
+export async function getActionDescription(client: Octokit, cache: TTLCache, step: Step): Promise<string | undefined> {
+  if (!isActionStep(step)) {
+    return undefined;
+  }
+  const action = parseActionReference(step.uses.value);
+  if (!action) {
+    return undefined;
+  }
+
+  const metadata = await fetchActionMetadata(client, cache, action);
+  if (!metadata?.name || !metadata?.description) {
+    return undefined;
+  }
+
+  return `[**${metadata.name}**](${actionUrl(action)})\n\n${metadata.description}`;
+}

languageserver/src/description-providers/action-input.test.ts

@@ -5,6 +5,7 @@ import fetchMock from "fetch-mock";
 import {createWorkflowContext} from "../test-utils/workflow-context";
 import {TTLCache} from "../utils/cache";
 import {getActionInputDescription} from "./action-input";
+import {actionsCheckoutMetadata} from "../test-utils/action-metadata";
 
 const workflow = `
 name: Hello World
@@ -16,49 +17,6 @@ jobs:
     - uses: actions/checkout@v3
 `;
 
-// A simplified version of the action.yml file from actions/checkout
-const actionMetadataContent = `
-name: 'Checkout'
-description: 'Checkout a Git repository at a particular version'
-inputs:
-  repository:
-    description: Repository name with owner. For example, actions/checkout
-    default: \${{ github.repository }}
-  ref:
-    description: The branch, tag or SHA to checkout.
-    required: true
-  token:
-    description: Personal access token (PAT) used to fetch the repository.
-    default: \${{ github.token }}
-  repo:
-    description: 'Repository name with owner. For example, actions/checkout'
-    deprecationMessage: 'Use repository instead'
-runs:
-  using: node16
-  main: dist/index.js
-  post: dist/index.js
-`;
-
-// Based on https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3
-const actionMetadata = {
-  name: "action.yml",
-  path: "action.yml",
-  sha: "cab09ebd3a964aba67b57f9727f5f6fff1372b04",
-  size: 3649,
-  url: "https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3",
-  html_url: "https://github.com/actions/checkout/blob/v3/action.yml",
-  git_url: "https://api.github.com/repos/actions/checkout/git/blobs/cab09ebd3a964aba67b57f9727f5f6fff1372b04",
-  download_url: "https://raw.githubusercontent.com/actions/checkout/v3/action.yml",
-  type: "file",
-  content: Buffer.from(actionMetadataContent).toString("base64"),
-  encoding: "base64",
-  _links: {
-    self: "https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3",
-    git: "https://api.github.com/repos/actions/checkout/git/blobs/cab09ebd3a964aba67b57f9727f5f6fff1372b04",
-    html: "https://github.com/actions/checkout/blob/v3/action.yml"
-  }
-};
-
 async function getDescription(input: string, mock: fetchMock.FetchMockSandbox) {
   const workflowContext = await createWorkflowContext(workflow, "build", 0);
 
@@ -74,11 +32,11 @@ async function getDescription(input: string, mock: fetchMock.FetchMockSandbox) {
   );
 }
 
-describe("action descriptions", () => {
+describe("action input descriptions", () => {
   it("optional input", async () => {
     const mock = fetchMock
       .sandbox()
-      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionMetadata);
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionsCheckoutMetadata);
 
     expect(await getDescription("repository", mock)).toEqual(
       "Repository name with owner. For example, actions/checkout"
@@ -88,7 +46,7 @@ describe("action descriptions", () => {
   it("required input", async () => {
     const mock = fetchMock
       .sandbox()
-      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionMetadata);
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionsCheckoutMetadata);
 
     expect(await getDescription("ref", mock)).toEqual("The branch, tag or SHA to checkout.\n\n**Required**");
   });
@@ -96,7 +54,7 @@ describe("action descriptions", () => {
   it("deprecated input", async () => {
     const mock = fetchMock
       .sandbox()
-      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionMetadata);
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionsCheckoutMetadata);
 
     expect(await getDescription("repo", mock)).toEqual(
       "Repository name with owner. For example, actions/checkout\n\n**Deprecated**"
@@ -106,7 +64,7 @@ describe("action descriptions", () => {
   it("invalid input", async () => {
     const mock = fetchMock
       .sandbox()
-      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionMetadata);
+      .getOnce("https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3", actionsCheckoutMetadata);
 
     expect(await getDescription("typo", mock)).toBeUndefined();
   });

languageserver/src/test-utils/action-metadata.ts

@@ -0,0 +1,42 @@
+// A simplified version of the action.yml file from actions/checkout
+const checkoutMetadataContent = `
+name: 'Checkout'
+description: 'Checkout a Git repository at a particular version'
+inputs:
+  repository:
+    description: Repository name with owner. For example, actions/checkout
+    default: \${{ github.repository }}
+  ref:
+    description: The branch, tag or SHA to checkout.
+    required: true
+  token:
+    description: Personal access token (PAT) used to fetch the repository.
+    default: \${{ github.token }}
+  repo:
+    description: 'Repository name with owner. For example, actions/checkout'
+    deprecationMessage: 'Use repository instead'
+runs:
+  using: node16
+  main: dist/index.js
+  post: dist/index.js
+`;
+
+// Based on https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3
+export const actionsCheckoutMetadata = {
+  name: "action.yml",
+  path: "action.yml",
+  sha: "cab09ebd3a964aba67b57f9727f5f6fff1372b04",
+  size: 3649,
+  url: "https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3",
+  html_url: "https://github.com/actions/checkout/blob/v3/action.yml",
+  git_url: "https://api.github.com/repos/actions/checkout/git/blobs/cab09ebd3a964aba67b57f9727f5f6fff1372b04",
+  download_url: "https://raw.githubusercontent.com/actions/checkout/v3/action.yml",
+  type: "file",
+  content: Buffer.from(checkoutMetadataContent).toString("base64"),
+  encoding: "base64",
+  _links: {
+    self: "https://api.github.com/repos/actions/checkout/contents/action.yml?ref=v3",
+    git: "https://api.github.com/repos/actions/checkout/git/blobs/cab09ebd3a964aba67b57f9727f5f6fff1372b04",
+    html: "https://github.com/actions/checkout/blob/v3/action.yml"
+  }
+};

languageservice/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@github/actions-languageservice",
-  "version": "0.1.155",
+  "version": "0.1.157",
   "description": "Language service for GitHub Actions",
   "license": "MIT",
   "type": "module",
@@ -39,8 +39,8 @@
     "watch": "tsc --build tsconfig.build.json --watch"
   },
   "dependencies": {
-    "@github/actions-expressions": "^0.1.155",
+    "@github/actions-expressions": "^0.1.157",
-    "@github/actions-workflow-parser": "^0.1.155",
+    "@github/actions-workflow-parser": "^0.1.157",
     "vscode-languageserver-textdocument": "^1.0.7",
     "vscode-languageserver-types": "^3.17.2",
     "yaml": "^2.1.1"

languageservice/src/action.ts

@@ -1,5 +1,7 @@
 // https://docs.github.com/en/actions/creating-actions/metadata-syntax-for-github-actions
 export type ActionMetadata = {
+  name: string;
+  description: string;
   inputs?: ActionInputs;
   outputs?: ActionOutputs;
 };
@@ -63,3 +65,10 @@ export function actionIdentifier(ref: ActionReference): string {
   }
   return `${ref.owner}/${ref.name}/${ref.ref}`;
 }
+
+export function actionUrl(actionRef: ActionReference): string {
+  // TODO: Support base uri for GHES
+  const gitHubBaseUri = "https://www.github.com/";
+
+  return `${gitHubBaseUri}${actionRef.owner}/${actionRef.name}/tree/${actionRef.ref}/${actionRef.path || ""}`;
+}

languageservice/src/complete.test.ts

@@ -338,6 +338,24 @@ jobs:
     expect(result).toHaveLength(16);
   });
 
+  it("complete from behind a colon will replace it", async () => {
+    const input = `
+on: push
+jobs:
+  one:
+    runs-on: ubuntu-latest
+    |:
+    - uses: actions/checkout@v2
+`;
+    const result = await complete(...getPositionFromCursor(input));
+    expect(result).toHaveLength(16);
+    let textEdit = result[0].textEdit as TextEdit;
+    expect(textEdit.range).toEqual({
+      start: {line: 5, character: 4},
+      end: {line: 5, character: 5}
+    });
+  });
+
   it("well known mapping keys have descriptions", async () => {
     const input = `
 o|

languageservice/src/complete.ts

@@ -103,7 +103,19 @@ export async function complete(
 
     // Get the length of the current word
     const val = line.match(/[\w_-]*$/)?.[0].length || 0;
-    replaceRange = Range.create({line: position.line, character: position.character - val}, position);
+    // Check if we need to remove a trailing colon
+    const charAfterPos = textDocument.getText({
+      start: {line: position.line, character: position.character},
+      end: {line: position.line, character: position.character + 1}
+    });
+    if (charAfterPos === ":") {
+      replaceRange = Range.create(
+        {line: position.line, character: position.character - val},
+        {line: position.line, character: position.character + 1}
+      );
+    } else {
+      replaceRange = Range.create({line: position.line, character: position.character - val}, position);
+    }
   }
 
   return values.map(value => {

languageservice/src/document-links.ts

@@ -3,7 +3,7 @@ import {isJob} from "@github/actions-workflow-parser/model/type-guards";
 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 {actionUrl, parseActionReference} from "./action";
 import {mapRange} from "./utils/range";
 import {fetchOrParseWorkflow, fetchOrConvertWorkflowTemplate} from "./utils/workflow-cache";
 
@@ -25,9 +25,6 @@ export async function documentLinks(document: TextDocument): Promise<DocumentLin
   // 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 || []) {
     if (!job || !isJob(job)) {
       continue;
@@ -39,9 +36,7 @@ export async function documentLinks(document: TextDocument): Promise<DocumentLin
           continue;
         }
 
-        const url = `${gitHubBaseUri}${actionRef.owner}/${actionRef.name}/tree/${actionRef.ref}/${
+        const url = actionUrl(actionRef);
-          actionRef.path || ""
-        }`;
 
         actionLinks.push({
           range: mapRange(step.uses.range),

languageservice/src/hover.test.ts

@@ -194,7 +194,7 @@ jobs:
       - uses|: actions/checkout@v2
 `;
 
-    const result = await hover(...getPositionFromCursor(input), testHoverConfig("uses", "non-empty-string", undefined));
+    const result = await hover(...getPositionFromCursor(input), testHoverConfig("uses", "step-uses", undefined));
     expect(result).not.toBeUndefined();
     expect(result?.contents).toEqual(
       "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image."

languageservice/src/validate.actions.test.ts

@@ -19,6 +19,8 @@ const validationConfig: ValidationConfig = {
     switch (ref.owner + "/" + ref.name + "@" + ref.ref) {
       case "actions/checkout@v3":
         metadata = {
+          name: "Checkout",
+          description: "Checkout a Git repository at a particular version",
           inputs: {
             repository: {
               description: "Repository name with owner",
@@ -29,6 +31,9 @@ const validationConfig: ValidationConfig = {
         break;
       case "actions/setup-node@v1":
         metadata = {
+          name: "Setup Node.js environment",
+          description:
+            "Setup a Node.js environment by adding problem matchers and optionally downloading and adding it to the PATH.",
           inputs: {
             version: {
               description: "Deprecated. Use node-version instead. Will not be supported after October 1, 2019",
@@ -40,6 +45,8 @@ const validationConfig: ValidationConfig = {
         break;
       case "actions/deploy-pages@main":
         metadata = {
+          name: "Deploy GitHub Pages site",
+          description: "A GitHub Action to deploy an artifact as a GitHub Pages site",
           inputs: {
             token: {
               required: true,
@@ -51,6 +58,8 @@ const validationConfig: ValidationConfig = {
         break;
       case "actions/cache@v1":
         metadata = {
+          name: "Cache",
+          description: "Cache artifacts like dependencies and build outputs to improve workflow execution time",
           inputs: {
             path: {
               description: "A directory to store and save the cache",
@@ -68,7 +77,10 @@ const validationConfig: ValidationConfig = {
         };
         break;
       case "actions/action-no-input@v1":
-        metadata = {};
+        metadata = {
+          name: "Action with no inputs",
+          description: "An action with no inputs"
+        };
     }
     return metadata;
   }

lerna.json

@@ -1,5 +1,5 @@
 {
   "$schema": "node_modules/lerna/schemas/lerna-schema.json",
   "useWorkspaces": true,
-  "version": "0.1.155"
+  "version": "0.1.157"
 }

package-lock.json

@@ -111,10 +111,10 @@
       }
     },
     "browser-playground": {
-      "version": "0.1.155",
+      "version": "0.1.157",
       "license": "MIT",
       "dependencies": {
-        "@github/actions-languageserver": "^0.1.155",
+        "@github/actions-languageserver": "^0.1.157",
         "monaco-editor-webpack-plugin": "^7.0.1",
         "monaco-editor-workers": "^0.34.2",
         "monaco-languageclient": "^4.0.3",
@@ -135,7 +135,7 @@
     },
     "expressions": {
       "name": "@github/actions-expressions",
-      "version": "0.1.155",
+      "version": "0.1.157",
       "license": "MIT",
       "devDependencies": {
         "@types/jest": "^29.0.3",
@@ -151,11 +151,11 @@
     },
     "languageserver": {
       "name": "@github/actions-languageserver",
-      "version": "0.1.155",
+      "version": "0.1.157",
       "license": "MIT",
       "dependencies": {
-        "@github/actions-languageservice": "^0.1.155",
+        "@github/actions-languageservice": "^0.1.157",
-        "@github/actions-workflow-parser": "^0.1.155",
+        "@github/actions-workflow-parser": "^0.1.157",
         "@octokit/rest": "^19.0.7",
         "vscode-languageserver": "^8.0.2",
         "vscode-languageserver-textdocument": "^1.0.7",
@@ -176,11 +176,11 @@
     },
     "languageservice": {
       "name": "@github/actions-languageservice",
-      "version": "0.1.155",
+      "version": "0.1.157",
       "license": "MIT",
       "dependencies": {
-        "@github/actions-expressions": "^0.1.155",
+        "@github/actions-expressions": "^0.1.157",
-        "@github/actions-workflow-parser": "^0.1.155",
+        "@github/actions-workflow-parser": "^0.1.157",
         "vscode-languageserver-textdocument": "^1.0.7",
         "vscode-languageserver-types": "^3.17.2",
         "yaml": "^2.1.1"
@@ -14265,10 +14265,10 @@
     },
     "workflow-parser": {
       "name": "@github/actions-workflow-parser",
-      "version": "0.1.155",
+      "version": "0.1.157",
       "license": "MIT",
       "dependencies": {
-        "@github/actions-expressions": "^0.1.155",
+        "@github/actions-expressions": "^0.1.157",
         "cronstrue": "^2.21.0",
         "yaml": "^2.0.0-8"
       },
@@ -14827,8 +14827,8 @@
     "@github/actions-languageserver": {
       "version": "file:languageserver",
       "requires": {
-        "@github/actions-languageservice": "^0.1.155",
+        "@github/actions-languageservice": "^0.1.157",
-        "@github/actions-workflow-parser": "^0.1.155",
+        "@github/actions-workflow-parser": "^0.1.157",
         "@octokit/rest": "^19.0.7",
         "@types/jest": "^29.0.3",
         "fetch-mock": "^9.11.0",
@@ -14845,8 +14845,8 @@
     "@github/actions-languageservice": {
       "version": "file:languageservice",
       "requires": {
-        "@github/actions-expressions": "^0.1.155",
+        "@github/actions-expressions": "^0.1.157",
-        "@github/actions-workflow-parser": "^0.1.155",
+        "@github/actions-workflow-parser": "^0.1.157",
         "@types/jest": "^29.0.3",
         "jest": "^29.0.3",
         "prettier": "^2.8.3",
@@ -14863,7 +14863,7 @@
     "@github/actions-workflow-parser": {
       "version": "file:workflow-parser",
       "requires": {
-        "@github/actions-expressions": "^0.1.155",
+        "@github/actions-expressions": "^0.1.157",
         "@types/jest": "^29.0.3",
         "@typescript-eslint/eslint-plugin": "^5.40.0",
         "@typescript-eslint/parser": "^5.40.0",
@@ -17857,7 +17857,7 @@
     "browser-playground": {
       "version": "file:browser-playground",
       "requires": {
-        "@github/actions-languageserver": "^0.1.155",
+        "@github/actions-languageserver": "^0.1.157",
         "css-loader": "^6.7.2",
         "monaco-editor-webpack-plugin": "^7.0.1",
         "monaco-editor-workers": "^0.34.2",

workflow-parser/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@github/actions-workflow-parser",
-  "version": "0.1.155",
+  "version": "0.1.157",
   "license": "MIT",
   "type": "module",
   "source": "./src/index.ts",
@@ -40,7 +40,7 @@
     "watch": "tsc --build tsconfig.build.json --watch"
   },
   "dependencies": {
-    "@github/actions-expressions": "^0.1.155",
+    "@github/actions-expressions": "^0.1.157",
     "cronstrue": "^2.21.0",
     "yaml": "^2.0.0-8"
   },

workflow-parser/src/workflow-v1.0.json

@@ -2044,8 +2044,7 @@
           "continue-on-error": "step-continue-on-error",
           "timeout-minutes": "step-timeout-minutes",
           "uses": {
-            "description": "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image.",
+            "type": "step-uses",
-            "type": "non-empty-string",
             "required": true
           },
           "with": "step-with",
@@ -2053,6 +2052,12 @@
         }
       }
     },
+    "step-uses": {
+      "description": "Selects an action to run as part of a step in your job. An action is a reusable unit of code. You can use an action defined in the same repository as the workflow, a public repository, or in a published Docker container image.",
+      "string": {
+        "require-non-empty": true
+      }
+    },
     "step-continue-on-error": {
       "context": [
         "github",