diff --git a/package.json b/package.json index 760fbd302..9e8762cab 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "danger", - "version": "11.0.6", + "version": "11.0.7", "description": "Unit tests for Team Culture", "main": "distribution/danger.js", "typings": "distribution/danger.d.ts", diff --git a/source/danger-incoming-process-schema.json b/source/danger-incoming-process-schema.json index a28f296a9..ff2143713 100644 --- a/source/danger-incoming-process-schema.json +++ b/source/danger-incoming-process-schema.json @@ -135410,6 +135410,10 @@ }, "type": "array" }, + "setSummaryMarkdown": { + "description": "Sets a markdown summary which shows on the overview page for the\nresults of all steps in your CI job.\n\nSee: https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/", + "type": "object" + }, "thisPR": { "$ref": "#/definitions/GitHubAPIPR", "description": "The PR metadata specifically formatted for using with the GitHub API client" diff --git a/source/danger-outgoing-process-schema.json b/source/danger-outgoing-process-schema.json index 099a7ba7d..d4cfabfad 100644 --- a/source/danger-outgoing-process-schema.json +++ b/source/danger-outgoing-process-schema.json @@ -33,6 +33,15 @@ }, "type": "array" }, + "github": { + "properties": { + "stepSummary": { + "description": "Markdown text which gets added as a summary in the first\npage which you see when you click through to the PR results.\n\nhttps://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/", + "type": "string" + } + }, + "type": "object" + }, "markdowns": { "description": "Markdown messages to attach at the bottom of the comment", "items": { diff --git a/source/danger.d.ts b/source/danger.d.ts index 002aac7d2..3c6c8d005 100644 --- a/source/danger.d.ts +++ b/source/danger.d.ts @@ -719,6 +719,15 @@ interface DangerResults { */ markdowns: Violation[] + github?: { + /** + * Markdown text which gets added as a summary in the first + * page which you see when you click through to the PR results. + * + * https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/ */ + stepSummary?: string + } + /** Meta information about the runtime evaluation */ meta?: { /** E.g. "dangerJS", or "Danger Swift" */ @@ -1009,6 +1018,13 @@ interface GitHubDSL extends GitHubJSONDSL { api: GitHub /** A scope for useful functions related to GitHub */ utils: GitHubUtilsDSL + /** + * Sets a markdown summary which shows on the overview page for the + * results of all steps in your CI job. + * + * See: https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/ + */ + setSummaryMarkdown: (markdown: string) => void } /** Useful functions for GitHub related work */