feat(core): allow markdown in stage-level comments (#4988)

spinnaker · Mar 12, 2018 · 7cc0a15 · 7cc0a15
1 parent 524210b
commit 7cc0a15
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/app/scripts/modules/core/src/pipeline/config/stages/core/executionSummary.html b/app/scripts/modules/core/src/pipeline/config/stages/core/executionSummary.html
@@ -55,6 +55,6 @@ <h6 ng-if="stage.context.restartDetails">Restarted by {{stage.context.restartDet
   </table>
   <div ng-if="stageSummary.comments">
     <strong>Comments</strong>
-    <p ng-bind-html="stageSummary.comments"></p>
+    <p ng-bind-html="$ctrl.getComments()"></p>
   </div>
 </div>
diff --git a/app/scripts/modules/core/src/pipeline/details/stageSummary.component.ts b/app/scripts/modules/core/src/pipeline/details/stageSummary.component.ts
@@ -1,5 +1,6 @@
 import { module, IController, IComponentOptions, IScope } from 'angular';
 import { StateParams, StateService } from '@uirouter/angularjs';
+import { HtmlRenderer, Parser } from 'commonmark';
 
 import { Application } from 'core/application';
 import { IExecution, IExecutionStage, IExecutionStageSummary, IStage } from 'core/domain';
@@ -12,6 +13,9 @@ export class StageSummaryController implements IController {
   public stage: IExecutionStage;
   public stageSummary: IExecutionStageSummary;
 
+  private parser: Parser = new Parser();
+  private renderer: HtmlRenderer = new HtmlRenderer();
+
   constructor(private $scope: IScope,
               private $stateParams: StateParams,
               private $state: StateService,
@@ -47,6 +51,11 @@ export class StageSummaryController implements IController {
     }
   }
 
+  public getComments(): string {
+    const parsed = this.parser.parse(this.stageSummary.comments);
+    return this.renderer.render(parsed);
+  }
+
   public getCurrentStep() {
     return parseInt(this.$stateParams.step, 10);
   }