feat: add title and defaultStageDisplayName inputs

This adds two new inputs to the action.

1. `title` an optional title to include with each stage comment
2. `defaultStageDisplayName` an optional name to use for the default
   stage instead of `DefaultStage`

closes #130

Author: corymhall

.projen/tasks.json

@@ -89,6 +89,16 @@ const project = new GitHubActionTypeScriptProject({
         required: false,
         default: 'change-set',
       },
+      defaultStageDisplayName: {
+        description: 'An optional display name for the CDK default stage.',
+        required: false,
+        default: 'DefaultStage',
+      },
+      title: {
+        description: 'An optional title for each diff comment on the PR.',
+        required: false,
+        default: '',
+      },
     },
     runs: {
       using: RunsUsing.NODE_20,
@@ -252,6 +262,6 @@ workflow?.on({
 });
 
 projenProject.packageTask.reset();
-projenProject.packageTask.exec('cp node_modules/@aws-cdk/aws-service-spec/db.json.gz ./ && ncc build src/index.ts --source-map --transpile-only --license licenses.txt');
+projenProject.packageTask.exec('cp node_modules/@aws-cdk/aws-service-spec/db.json.gz ./ && ncc build --source-map --license licenses.txt');
 workflow?.addJobs({ enableAutoMerge: autoMergeJob });
 project.synth();

.projenrc.ts

@@ -7,6 +7,8 @@ import { AssemblyProcessor } from './stage-processor';
 
 export async function run() {
   const inputs: Inputs = {
+    title: getInput('title') || undefined,
+    defaultStageDisplayName: getInput('defaultStageDisplayName', { required: true }),
     allowedDestroyTypes: getMultilineInput('allowedDestroyTypes'),
     failOnDestructiveChanges: getBooleanInput('failOnDestructiveChanges'),
     githubToken: getInput('githubToken'),

action.yml

@@ -69,4 +69,18 @@ export interface Inputs {
    * @default cdk.out
    */
   cdkOutDir: string;
+
+  /**
+   * An optional display name for the CDK default stage.
+   *
+   * @default DefaultStage
+   */
+  defaultStageDisplayName: string;
+
+  /**
+   * An optional title for each diff comment on the PR.
+   *
+   * @default - no title
+   */
+  title?: string;
 }

dist/index.js

@@ -22,6 +22,11 @@ interface StageComment {
    */
   stackComments: { [stackName: string]: string[] };
 
+  /**
+   * The title of the comment
+   */
+  title?: string;
+
   /**
    * The unique hash for the stage comment
    * This will be used to lookup the stage comment on the PR
@@ -38,6 +43,7 @@ interface StageComment {
 export interface AssemblyProcessorOptions extends Omit<Inputs, 'githubToken' | 'diffMethod'> {
   diffMethod: DiffMethod;
   toolkit: Toolkit;
+  defaultStageDisplayName: string;
 }
 
 /**
@@ -63,7 +69,7 @@ export class AssemblyProcessor {
     this._stageInfo = assembly.stages;
     if (assembly.stacks.length) {
       this.stageInfo.push({
-        name: 'DefaultStage',
+        name: this.options.defaultStageDisplayName,
         stacks: assembly.stacks,
       });
     }
@@ -83,13 +89,15 @@ export class AssemblyProcessor {
     }
     this._stages = this.stageInfo.flatMap(stage => {
       this.stageComments[stage.name] = {
+        title: this.options.title,
         destructiveChanges: 0,
         stackComments: stage.stacks.reduce((prev, curr) => {
           prev[curr.name] = [];
           return prev;
         }, {} as { [stackName: string]: string[] }),
         hash: md5Hash(JSON.stringify({
           stageName: stage.name,
+          title: this.options.title,
           ...stage.stacks.reduce((prev, curr) => {
             prev.stacks.push({
               name: curr.name,
@@ -256,6 +264,10 @@ export class AssemblyProcessor {
   private formatStackComment(stackName: string, diff: TemplateDiff, changes: ChangeDetails): string[] {
     const output: string[] = [];
     const emoji = this.getEmoji(changes);
+    if (this.options.title) {
+      output.push(`## ${this.options.title}`);
+      output.push('');
+    }
     if (diff.isEmpty) {
       output.push(`No Changes for stack: ${stackName} ${emoji}`);
       return output;

dist/index.js.map

@@ -101,6 +101,7 @@ describe('StageProcessor', () => {
       'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
     });
     const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
       toolkit,
       allowedDestroyTypes: [],
       cdkOutDir: 'cdk.out',
@@ -134,6 +135,7 @@ describe('StageProcessor', () => {
       'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
     });
     const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
       toolkit,
       allowedDestroyTypes: [],
       cdkOutDir: 'cdk.out',
@@ -168,6 +170,7 @@ describe('StageProcessor', () => {
       'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
     });
     const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
       toolkit,
       allowedDestroyTypes: [],
       cdkOutDir: 'cdk.out',
@@ -202,6 +205,7 @@ describe('StageProcessor', () => {
       'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
     });
     const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
       toolkit,
       allowedDestroyTypes: [],
       cdkOutDir: 'cdk.out',
@@ -234,6 +238,7 @@ describe('StageProcessor', () => {
       'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
     });
     const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
       toolkit,
       allowedDestroyTypes: [],
       cdkOutDir: 'cdk.out',
@@ -342,6 +347,7 @@ describe('StageProcessor', () => {
       'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
     });
     const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
       toolkit,
       allowedDestroyTypes: [],
       cdkOutDir: 'cdk.out',
@@ -360,6 +366,100 @@ describe('StageProcessor', () => {
     expect(p.SomeStage.stackComments['SomeOtherStage-test-stack']).toEqual(undefined);
     expect(p.SomeStage.destructiveChanges).toEqual(1);
   });
+
+});
+
+describe('default stage', () => {
+  beforeEach(() => {
+
+    mockOutDir = {
+      'manifest.json': JSON.stringify({
+        version: '36.0.0',
+        artifacts: {
+          'test-stack': {
+            type: 'aws:cloudformation:stack',
+            environment: 'aws://unknown-account/unknown-region',
+            properties: {
+              templateFile: 'test-stack.template.json',
+              validateOnSynth: false,
+              stackName: 'test-stack',
+            },
+            displayName: 'test-stack',
+          },
+        },
+      }),
+      ['test-stack.template.json']: JSON.stringify({
+        Resources: {
+          MyRole: {
+            Type: 'AWS::IAM::Role',
+            Properties: {
+              RoleName: 'MyCustomName',
+            },
+          },
+        },
+      }),
+    };
+
+    mockOutDir['SomeStage-test-stack.template.json'] = JSON.stringify({
+      Resources: {
+        MyRole: {
+          Type: 'AWS::IAM::Role',
+          Properties: {
+            RoleName: 'MyCustomName',
+          },
+        },
+      },
+    });
+  });
+
+  test('with defaults', async () => {
+    mock({
+      'cdk.out': mockOutDir,
+      'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
+    });
+    const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
+      toolkit,
+      allowedDestroyTypes: [],
+      cdkOutDir: 'cdk.out',
+      diffMethod: DiffMethod.LocalFile('cdk.out/SomeStage-test-stack.template.json'),
+      failOnDestructiveChanges: true,
+      stackSelectorPatterns: [],
+      stackSelectionStrategy: 'all-stacks',
+      noFailOnDestructiveChanges: [],
+    });
+    await processor.processStages();
+    const p = (processor as any).stageComments;
+    expect(p).toEqual({
+      DefaultStage: expect.any(Object),
+    });
+    expect(p.DefaultStage.stackComments['test-stack']).toEqual(['No Changes for stack: test-stack :white_check_mark:']);
+  });
+
+  test('with custom', async () => {
+    mock({
+      'cdk.out': mockOutDir,
+      'node_modules': mock.load(path.join(__dirname, '..', 'node_modules')),
+    });
+    const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'MyStage',
+      title: 'Diff for MyStage',
+      toolkit,
+      allowedDestroyTypes: [],
+      cdkOutDir: 'cdk.out',
+      diffMethod: DiffMethod.LocalFile('cdk.out/SomeStage-test-stack.template.json'),
+      failOnDestructiveChanges: true,
+      stackSelectorPatterns: [],
+      stackSelectionStrategy: 'all-stacks',
+      noFailOnDestructiveChanges: [],
+    });
+    await processor.processStages();
+    const p = (processor as any).stageComments;
+    expect(p).toEqual({
+      MyStage: expect.any(Object),
+    });
+    expect(p.MyStage.stackComments['test-stack']).toEqual(['## Diff for MyStage', '', 'No Changes for stack: test-stack :white_check_mark:']);
+  });
 });
 
 describe('stack comments', () => {
@@ -403,6 +503,7 @@ describe('stack comments', () => {
 
     jest.spyOn(Toolkit.prototype, 'diff').mockResolvedValue(templateDiff);
     const processor = new AssemblyProcessor({
+      defaultStageDisplayName: 'DefaultStage',
       toolkit,
       allowedDestroyTypes: [],
       cdkOutDir: 'cdk.out',