Merge branch 'develop' into mdk/develop

Author: knieczyszczak

packages/formatters/src/__tests__/github-actions.jest.test.ts

@@ -37,14 +37,15 @@ const results: IRuleResult[] = [
         character: 60,
       },
     },
+    documentationUrl: 'https://example.com/pets',
   },
 ];
 
 describe('GitHub Actions formatter', () => {
   test('should be formatted correctly', () => {
     expect(githubActions(results, { failSeverity: DiagnosticSeverity.Error }).split('\n')).toEqual([
       '::warning title=operation-description,file=__tests__/fixtures/petstore.oas2.yaml,col=9,endColumn=61,line=61,endLine=72::paths./pets.get.description is not truthy%0AMessage can have%0Amultiple lines',
-      '::warning title=operation-tags,file=__tests__/fixtures/petstore.oas2.yaml,col=9,endColumn=61,line=61,endLine=72::paths./pets.get.tags is not truthy',
+      '::warning title=operation-tags,file=__tests__/fixtures/petstore.oas2.yaml,col=9,endColumn=61,line=61,endLine=72::paths./pets.get.tags is not truthy%0ADocumentation: https://example.com/pets',
     ]);
   });
 });

packages/formatters/src/github-actions.ts

@@ -42,7 +42,7 @@ export const githubActions: Formatter = results => {
       const message = result.message.replace(/\n/g, '%0A');
 
       return `::${OUTPUT_TYPES[result.severity]} ${paramsString}::${message}${
-        result.documentationUrl ? `::${result.documentationUrl}` : ''
+        result.documentationUrl ? `%0ADocumentation: ${result.documentationUrl}` : ''
       }`;
     })
     .join('\n');

test-harness/scenarios/documentation-url/results-format-github-actions.scenario

@@ -54,6 +54,6 @@ info:
 ====command====
 {bin} lint {document} --format=github-actions --ruleset "{asset:ruleset.json}" --show-documentation-url
 ====stdout====
-::warning title=api-servers,file=document,col=1,endColumn=19,line=1,endLine=4::"servers" must be present and non-empty array.::https://www.example.com/docs/api-servers.md
+::warning title=api-servers,file=document,col=1,endColumn=19,line=1,endLine=4::"servers" must be present and non-empty array.%0ADocumentation: https://www.example.com/docs/api-servers.md
 ::warning title=info-contact,file=document,col=6,endColumn=19,line=2,endLine=4::Info object must have a "contact" object.
-::warning title=info-description,file=document,col=6,endColumn=19,line=2,endLine=4::Info "description" must be present and non-empty string.::https://www.example.com/docs/info-description.md
+::warning title=info-description,file=document,col=6,endColumn=19,line=2,endLine=4::Info "description" must be present and non-empty string.%0ADocumentation: https://www.example.com/docs/info-description.md

yarn.lock

@@ -14627,9 +14627,9 @@ __metadata:
   linkType: hard
 
 "undici@npm:^6.23.0":
-  version: 6.23.0
-  resolution: "undici@npm:6.23.0"
-  checksum: f0953920330375e76d1614381af07da9d7c21ad3244d0785b3f7bd4072635c20a1f432ef3a129baa3e4a92278ce32e9ea2ca8b5f0e0554a5739222af332c08fe
+  version: 6.24.1
+  resolution: "undici@npm:6.24.1"
+  checksum: 0baa81ede2b0deb9002692c4d614cdffb2c8c27bb41e4ce7380f95b4468ebb6fd9745b7a6da32b0cdf05b1554bd5e5a47a80babb0e5ca9d59401efe372d975ed
   languageName: node
   linkType: hard