Add trigger tracking to changelog

Author: cesarParra

examples/vitepress/docs/changelog.md

@@ -78,6 +78,12 @@ Eu excepteur irure occaecat adipisicing anim non consequat deserunt ipsum id ame
 
 Represents a speaker at an event.
 
+## New Triggers
+
+These triggers are new.
+
+- PaymentDeviceTrigger on Payment_Device__c
+
 ## New or Removed Fields to Custom Objects or Standard Objects
 
 These custom fields have been added or removed.

src/core/changelog/generate-change-log.ts

@@ -27,6 +27,8 @@ import { hookableTemplate } from '../markdown/templates/hookable';
 import changelogToSourceChangelog from './helpers/changelog-to-source-changelog';
 import { CustomMetadataMetadata } from '../reflection/sobject/reflect-custom-metadata-source';
 import { TriggerMetadata } from '../reflection/trigger/reflect-trigger-source';
+import { reflectTriggerSource } from '../reflection/trigger/reflect-trigger-source';
+import { filterTriggerFiles } from '#utils/source-bundle-utils';
 
 type Config = Omit<UserDefinedChangelogConfig, 'targetGenerator'>;
 
@@ -79,6 +81,13 @@ function reflect(bundles: UnparsedSourceBundle[], config: Omit<UserDefinedChange
         TE.map((parsedObjectFiles) => [...parsedApexFiles, ...parsedObjectFiles]),
       );
     }),
+    // Add trigger reflection
+    TE.chain((parsedFiles) => {
+      return pipe(
+        reflectTriggerSource(filterTriggerFiles(bundles)),
+        TE.map((parsedTriggerFiles) => [...parsedFiles, ...parsedTriggerFiles]),
+      );
+    }),
   );
 }
 

src/core/changelog/process-changelog.ts

@@ -22,7 +22,9 @@ type ModificationTypes =
   | 'NewField'
   | 'RemovedField'
   | 'NewCustomMetadataRecord'
-  | 'RemovedCustomMetadataRecord';
+  | 'RemovedCustomMetadataRecord'
+  | 'NewTrigger'
+  | 'RemovedTrigger';
 
 export type MemberModificationType = {
   __typename: ModificationTypes;
@@ -35,13 +37,20 @@ export type NewOrModifiedMember = {
   modifications: MemberModificationType[];
 };
 
+export type TriggerChange = {
+  triggerName: string;
+  objectName: string;
+};
+
 export type Changelog = {
   newApexTypes: string[];
   removedApexTypes: string[];
   newOrModifiedApexMembers: NewOrModifiedMember[];
   newCustomObjects: string[];
   removedCustomObjects: string[];
   customObjectModifications: NewOrModifiedMember[];
+  newTriggers: TriggerChange[];
+  removedTriggers: TriggerChange[];
 };
 
 export function hasChanges(changelog: Changelog): boolean {
@@ -63,6 +72,8 @@ export function processChangelog(oldVersion: VersionManifest, newVersion: Versio
       ...getCustomObjectModifications(oldVersion, newVersion),
       ...getNewOrModifiedExtensionFields(oldVersion, newVersion),
     ],
+    newTriggers: getNewTriggers(oldVersion, newVersion),
+    removedTriggers: getRemovedTriggers(oldVersion, newVersion),
   };
 }
 
@@ -80,6 +91,24 @@ function getRemovedApexTypes(oldVersion: VersionManifest, newVersion: VersionMan
     .map((type) => type.name);
 }
 
+function getNewTriggers(oldVersion: VersionManifest, newVersion: VersionManifest): TriggerChange[] {
+  return newVersion.types
+    .filter((newType): newType is TriggerMetadata => newType.type_name === 'trigger')
+    .filter(
+      (newTrigger) => !oldVersion.types.some((oldType) => oldType.name.toLowerCase() === newTrigger.name.toLowerCase()),
+    )
+    .map((trigger) => ({ triggerName: trigger.name, objectName: trigger.object_name }));
+}
+
+function getRemovedTriggers(oldVersion: VersionManifest, newVersion: VersionManifest): TriggerChange[] {
+  return oldVersion.types
+    .filter((newType): newType is TriggerMetadata => newType.type_name === 'trigger')
+    .filter(
+      (oldTrigger) => !newVersion.types.some((newType) => newType.name.toLowerCase() === oldTrigger.name.toLowerCase()),
+    )
+    .map((trigger) => ({ triggerName: trigger.name, objectName: trigger.object_name }));
+}
+
 function getNewCustomObjects(oldVersion: VersionManifest, newVersion: VersionManifest): string[] {
   return newVersion.types
     .filter((newType): newType is CustomObjectMetadata => newType.type_name === 'customobject')

src/core/changelog/renderable-changelog.ts

@@ -19,6 +19,15 @@ type NewTypeSection<T extends 'class' | 'interface' | 'enum' | 'customobject'> =
   types: NewTypeRenderable[];
 };
 
+type NewOrRemovedTriggerSection = {
+  heading: string;
+  description: string;
+  triggerData: {
+    triggerName: string;
+    objectName: string;
+  }[];
+};
+
 type RemovedTypeSection = {
   heading: string;
   description: string;
@@ -46,6 +55,8 @@ export type RenderableChangelog = {
   removedCustomObjects: RemovedTypeSection | null;
   newOrRemovedCustomFields: NewOrModifiedMembersSection | null;
   newOrRemovedCustomMetadataTypeRecords: NewOrModifiedMembersSection | null;
+  newTriggers: NewOrRemovedTriggerSection | null;
+  removedTriggers: NewOrRemovedTriggerSection | null;
 };
 
 export function convertToRenderableChangelog(
@@ -149,6 +160,28 @@ export function convertToRenderableChangelog(
             modifications: newOrModifiedCustomMetadataTypeRecords.map(toRenderableModification),
           }
         : null,
+    newTriggers:
+      changelog.newTriggers.length > 0
+        ? {
+            heading: 'New Triggers',
+            description: 'These triggers are new.',
+            triggerData: changelog.newTriggers.map((trigger) => ({
+              triggerName: trigger.triggerName,
+              objectName: trigger.objectName,
+            })),
+          }
+        : null,
+    removedTriggers:
+      changelog.removedTriggers.length > 0
+        ? {
+            heading: 'Removed Triggers',
+            description: 'These triggers have been removed.',
+            triggerData: changelog.removedTriggers.map((trigger) => ({
+              triggerName: trigger.triggerName,
+              objectName: trigger.objectName,
+            })),
+          }
+        : null,
   };
 }
 
@@ -204,5 +237,9 @@ function toRenderableModificationDescription(memberModificationType: MemberModif
       return `New Custom Metadata Record: ${withDescription(memberModificationType)}`;
     case 'RemovedCustomMetadataRecord':
       return `Removed Custom Metadata Record: ${memberModificationType.name}`;
+    case 'NewTrigger':
+      return `New Trigger: ${withDescription(memberModificationType)}`;
+    case 'RemovedTrigger':
+      return `Removed Trigger: ${memberModificationType.name}`;
   }
 }

src/core/changelog/templates/changelog-template.ts

@@ -49,6 +49,26 @@ export const changelogTemplate = `
 {{/each}}
 {{/if}}
 
+{{#if newTriggers}}
+## {{newTriggers.heading}}
+
+{{newTriggers.description}}
+
+{{#each newTriggers.triggerData}}
+- {{this.triggerName}} on {{this.objectName}}
+{{/each}}
+{{/if}}
+
+{{#if removedTriggers}}
+## {{removedTriggers.heading}}
+
+{{removedTriggers.description}}
+
+{{#each removedTriggers.triggerData}}
+- {{this.triggerName}} on {{this.objectName}}
+{{/each}}
+{{/if}}
+
 {{#if removedTypes}}
 ## {{removedTypes.heading}}