diff --git a/languageservice/src/complete.test.ts b/languageservice/src/complete.test.ts index 3971f96..f4ca821 100644 --- a/languageservice/src/complete.test.ts +++ b/languageservice/src/complete.test.ts @@ -44,7 +44,7 @@ jobs: const result = await complete(...getPositionFromCursor(input)); expect(result).not.toBeUndefined(); - expect(result.length).toEqual(8); + expect(result.length).toEqual(9); expect(result[0].label).toEqual("concurrency"); }); diff --git a/languageservice/src/e2e.test.ts b/languageservice/src/e2e.test.ts index 433b3a8..cfcc282 100644 --- a/languageservice/src/e2e.test.ts +++ b/languageservice/src/e2e.test.ts @@ -21,8 +21,18 @@ describe("end-to-end", () => { const result = await complete(...getPositionFromCursor(input)); expect(result).not.toBeUndefined(); - expect(result.length).toEqual(8); + expect(result.length).toEqual(9); const labels = result.map(x => x.label); - expect(labels).toEqual(["concurrency", "defaults", "env", "jobs", "name", "on", "permissions", "run-name"]); + expect(labels).toEqual([ + "concurrency", + "defaults", + "description", + "env", + "jobs", + "name", + "on", + "permissions", + "run-name" + ]); }); }); diff --git a/workflow-parser/src/workflow-v1.0.json b/workflow-parser/src/workflow-v1.0.json index 2f4120a..3a121b1 100644 --- a/workflow-parser/src/workflow-v1.0.json +++ b/workflow-parser/src/workflow-v1.0.json @@ -7,6 +7,7 @@ "properties": { "on": "on", "name": "workflow-name", + "description": "workflow-description", "run-name": "run-name", "defaults": "workflow-defaults", "env": "workflow-env", @@ -28,6 +29,7 @@ "required": true }, "name": "workflow-name", + "description": "workflow-description", "run-name": "run-name", "defaults": "workflow-defaults", "env": "workflow-env", @@ -44,6 +46,10 @@ "description": "The name of the workflow that GitHub displays on your repository's 'Actions' tab.\n\n[Documentation](https://docs.github.com/actions/using-workflows/workflow-syntax-for-github-actions#name)", "string": {} }, + "workflow-description": { + "description": "A description for your workflow or reusable workflow", + "string": {} + }, "run-name": { "context": [ "github", diff --git a/workflow-parser/testdata/reader/workflow-description.yml b/workflow-parser/testdata/reader/workflow-description.yml new file mode 100644 index 0000000..8d60f5c --- /dev/null +++ b/workflow-parser/testdata/reader/workflow-description.yml @@ -0,0 +1,34 @@ +include-source: false # Drop file/line/col from output +--- +description: My workflow description +on: push +jobs: + build: + runs-on: ubuntu-latest + steps: + - run: echo hi +--- +{ + "jobs": [ + { + "type": "job", + "id": "build", + "name": "build", + "if": { + "type": 3, + "expr": "success()" + }, + "runs-on": "ubuntu-latest", + "steps": [ + { + "id": "__run", + "if": { + "type": 3, + "expr": "success()" + }, + "run": "echo hi" + } + ] + } + ] +} \ No newline at end of file