@docupace/pipeline 1.0.105 → 1.0.106

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docupace/pipeline",
-  "version": "1.0.105",
+  "version": "1.0.106",
   "description": "",
   "main": "index.js",
   "type": "module",

package/src/changeset/canny.js

@@ -16,50 +16,83 @@ export async function uploadToCanny(releaseNote, labelIDs) {
   }
 
   try {
-    // Prepare the content for Canny based on the release notes
     const title = releaseNote.title;
     let content = '';
+    let entryType;
 
-    // Include user-facing description if available
-    if (
-      releaseNote.userFacingDescription &&
-      releaseNote.userFacingDescription.__line.trim()
-    ) {
-      content += `${releaseNote.summary}\n\n`;
-      content += `${releaseNote.userFacingDescription.__line}\n\n`;
-    } else {
+    if (Array.isArray(releaseNote.whatsNew)) {
+      // New format
       content += `${releaseNote.summary}\n\n`;
-    }
-
-    // Include technical details if available
-    if (
-      releaseNote.technicalDescription &&
-      releaseNote.technicalDescription.__line.trim()
-    ) {
-      content += `**Technical Details**\n\n${releaseNote.technicalDescription.__line}\n\n`;
-    }
-
-    // Add JIRA reference
-    content += `**Reference**: JIRA ticket [${releaseNote.ticketId}]`;
 
-    // Map our changeType to Canny's type parameter
-    let entryType;
-    if (releaseNote.changeType === 'New') {
-      entryType = 'new';
-    } else if (releaseNote.changeType === 'Improved') {
-      entryType = 'improved';
-    } else if (releaseNote.changeType === 'Fixed') {
-      entryType = 'fixed';
+      content += `**What's New**\n\n`;
+      releaseNote.whatsNew.forEach((item) => (content += `- ${item}\n`));
+      content += '\n';
+
+      content += `**Why This Matters**\n\n${releaseNote.whyThisMatters}\n\n`;
+
+      if (releaseNote.whoIsImpacted?.length) {
+        content += `**Who Is Impacted**\n\n`;
+        releaseNote.whoIsImpacted.forEach((item) => (content += `- ${item}\n`));
+        content += '\n';
+      }
+
+      if (releaseNote.actionRequired?.length) {
+        content += `**Action Required**\n\n`;
+        releaseNote.actionRequired.forEach(
+          (item) => (content += `- ${item}\n`),
+        );
+        content += '\n';
+      }
+
+      if (releaseNote.technicalDetails?.length) {
+        content += `**Technical Details**\n\n`;
+        releaseNote.technicalDetails.forEach(
+          (item) => (content += `- ${item}\n`),
+        );
+      }
+    } else {
+      // Old format (backwards compatibility)
+      if (
+        releaseNote.userFacingDescription &&
+        releaseNote.userFacingDescription.__line?.trim()
+      ) {
+        content += `${releaseNote.summary}\n\n`;
+        content += `${releaseNote.userFacingDescription.__line}\n\n`;
+      } else {
+        content += `${releaseNote.summary}\n\n`;
+      }
+
+      if (
+        releaseNote.technicalDescription &&
+        releaseNote.technicalDescription.__line?.trim()
+      ) {
+        content += `**Technical Details**\n\n${releaseNote.technicalDescription.__line}\n\n`;
+      }
+
+      content += `**Reference**: JIRA ticket [${releaseNote.ticketId}]`;
+
+      if (releaseNote.changeType === 'New') {
+        entryType = 'new';
+      } else if (releaseNote.changeType === 'Improved') {
+        entryType = 'improved';
+      } else if (releaseNote.changeType === 'Fixed') {
+        entryType = 'fixed';
+      }
     }
 
-    const body = JSON.stringify({
+    const bodyPayload = {
       apiKey: CANNY_API_KEY,
       title: title,
       details: content,
-      type: entryType,
       published: false, // Keep as draft initially
       labelIDs,
-    });
+    };
+
+    if (entryType) {
+      bodyPayload.type = entryType;
+    }
+
+    const body = JSON.stringify(bodyPayload);
 
     // Create a new changelog entry in Canny
     const createResponse = await fetch(

package/src/changeset/cli.js

@@ -196,12 +196,12 @@ program
   });
 
 program
-  .name('create-changeset')
+  .command('create-changeset [jiraTicketKey]')
   .description(
     'Creates a changeset based on the current branch and Jira ticket information',
   )
-  .action(async () => {
-    await createChangeset();
+  .action(async (jiraTicketKey) => {
+    await createChangeset(jiraTicketKey);
   });
 
 // Command: convert-prepare

package/src/changeset/openai.js

@@ -21,27 +21,20 @@ const CHANGESET_DIR = path.join(process.cwd(), '.release-notes');
 
 // Define the Zod schema for OpenAI response
 const openAiResponseSchema = z.object({
-  title: z
-    .string()
-    .describe('A concise title for the release note (3-8 words)'),
-  summary: z.string().describe('A brief user-facing summary of changes'),
-  technicalDescription: z
-    .string()
-    .optional()
-    .describe('Developer-friendly description of technical changes'),
-  userFacingDescription: z
-    .string()
-    .optional()
-    .describe('Plain-language description of changes from a user perspective'),
-  technicalOnly: z
-    .boolean()
-    .describe(
-      'Whether this change is technical-only with no user-visible impact',
-    ),
-  changeSize: z
-    .enum(['Small', 'Medium', 'Large'])
-    .describe('Size/scope of the change'),
-  changeType: z.enum(['New', 'Improved', 'Fixed']).describe('Type of change'),
+  title: z.string().describe('Title with [Audience] prefix'),
+  summary: z.string().describe('1-2 sentence executive summary'),
+  whatsNew: z
+    .array(z.string())
+    .describe('Flat bullets of user-visible behavior'),
+  whyThisMatters: z.string().describe('1-3 sentences on practical impact'),
+  whoIsImpacted: z.array(z.string()).describe('Audience bullets'),
+  actionRequired: z
+    .array(z.string())
+    .describe('Action bullets or ["No action required."]'),
+  technicalDetails: z
+    .array(z.string())
+    .describe('Technical detail bullets ending with Reference'),
+  tags: z.array(z.string()).describe('Approved tags'),
 });
 
 // Define the Zod schema for changelog summary
@@ -332,31 +325,67 @@ export async function generateEnhancedReleaseNotes(ticketData) {
   if (!ticketData) return null;
 
   try {
-    const systemPrompt = `Process the provided JSON from a Jira ticket to generate structured release notes in JSON format.
-Follow this strict schema to generate your response:
+    const systemPrompt = `
+Generate client-facing release notes in JSON from the provided Jira ticket JSON.
+
+Return ONLY valid JSON matching this schema exactly (no extra keys):
 
 {
-  "title": "A concise title for the release note (3-8 words)",
-  "summary": "A brief user-facing summary of changes (max 2 sentences)",
-  "technicalDescription": "Developer-friendly description of technical changes in markdown format (max 5 sentences)",
-  "userFacingDescription": "Provide only if changes made to user interface. Plain-language description of changes from a user perspective in markdown format (max 5 sentences)",
-  "technicalOnly": boolean (true/false whether this change is only technical with no user-visible impact),
-  "changeType": "New" | "Improved" | "Fixed",
-  "changeSize": "Small" | "Medium" | "Large"
+  “title”: “[Audience] Concise, Title-Case Summary”,
+  “summary”: “1–2 sentences.”,
+  “whatsNew”: [“Flat bullet”],
+  “whyThisMatters”: “1–3 sentences.”,
+  “whoIsImpacted”: [“Flat bullet or 'All users'”],
+  “actionRequired”: [“Flat bullet or exactly 'No action required.'”],
+  “technicalDetails”: [“Flat bullet”, “Reference: ABC-1234”],
+  “tags”: [“ApprovedTag”]
 }
 
-When creating your response:
-- Title: Create a concise title summarizing the change (3–8 words). Avoid repeating the Jira ticket title.
-- Summary: Write a maximum two-sentence summary in user-facing language.
-- Technical Description: Use developer-friendly language to explain what changed at the system or code level. Include only if specified: API impacts, architectural changes, or deployment considerations. Format using markdown. Use backticks for code (\`like_this\`), bold for important terms, and line breaks for readability. Avoid headings like Technical Changes
-- User-Facing Description: Provide only if changes are made to the user interface. Use plain language to explain what users will see or benefit from. Include affected UI elements, workflows, or systems. Prefer bullet points if listing multiple effects or changes. Use markdown formatting for clarity.
-- Technical Only: Set to true if the change has no visible effect to end users. Examples for technical only are API changes, refactoring of code or architectual changes that do not have changes to the user interface
-- Change Type: Classify as “New”, “Improved”, or “Fixed”.
-- Change Size: Estimate the impact as “Small”, “Medium”, or “Large”.
-
-For Descriptions:
-Avoid large blocks of text. Break content into short paragraphs or lists. Use markdown consistently: code, bold, italic, and single level bullet lists (- Item). Make your response easy to scan, especially the descriptions. Focus on what changed, how it works, and where it applies.
-Avoid restating the ticket title. Focus on what changed, how it works, and where it applies.
+ALL FIELDS ARE REQUIRED.
+
+TITLE
+- Must start with [Audience] where Audience is one of: All, Admins, Devs, Front Office, Back Office
+- If the Jira explicitly states “all users”, use [All].
+
+SUMMARY
+- 1–2 sentences, present tense, executive-level, no speculation.
+
+WHAT'S NEW
+- Flat bullets only, present tense, user-visible behavior only.
+
+WHY THIS MATTERS
+- 1–3 sentences, practical impact directly inferable from What's New. Do not restate What's New.
+
+WHO IS IMPACTED
+- Must align with the Title audience. Use “All users” if broadly applicable.
+
+ACTION REQUIRED
+- Flat bullets only.
+- If none: [“No action required.”] exactly.
+- If separate deployment/enablement/manual activation is mentioned, include a customer-facing action bullet.
+
+TECHNICAL DETAILS
+- Flat bullets only.
+- Describe the functional change with concrete specificity (behavioral change, validation logic, configuration impact, or integration touchpoints).
+- Do not include internal architecture, endpoints, schemas, environments, or internal tools.
+- Final bullet MUST be: “Reference: <JIRA-KEY>” verbatim.
+
+TAGS
+Use only:
+Technical, Enterprise Core, Account Opening, Admin Settings, APIs & Integrations, Authentication & SSO, Compliance & Disclosures, CRM Connections, Custodians, Documents & Uploads, eSignature, Form Fields & Validations, Performance & Speed, Security, System Configuration, User Experience, Workflows
+
+FAILURE FLAGS (MANDATORY)
+If any field can only be completed by guessing:
+- Include what is supported by the Jira input and add as the final sentence (string fields) or final bullet (array fields):
+“[PARTIAL — ADDITIONAL SOURCE DETAIL REQUIRED]”
+If no reliable content can be produced for a field:
+- For string fields set the value to:
+“[UNABLE TO GENERATE — INSUFFICIENT SOURCE DETAIL]”
+- For array fields set the value to:
+[“[UNABLE TO GENERATE — INSUFFICIENT SOURCE DETAIL]”]
+
+Use active voice. Short sentences. No marketing language.
+Return JSON only.
 `;
 
     const userPrompt = JSON.stringify(ticketData, null, 2);
@@ -382,46 +411,51 @@ Avoid restating the ticket title. Focus on what changed, how it works, and where
               properties: {
                 title: {
                   type: 'string',
-                  description:
-                    'A concise title for the release note (3-8 words)',
+                  description: 'Title with [Audience] prefix',
                 },
                 summary: {
                   type: 'string',
-                  description:
-                    'A brief user-facing summary of changes (max 2 sentences)',
+                  description: '1-2 sentence executive summary',
                 },
-                technicalDescription: {
-                  type: 'string',
-                  description:
-                    'Developer-friendly description of technical changes (max 5 sentences)',
+                whatsNew: {
+                  type: 'array',
+                  items: { type: 'string' },
+                  description: 'Flat bullets of user-visible behavior',
                 },
-                userFacingDescription: {
+                whyThisMatters: {
                   type: 'string',
-                  description:
-                    'Plain-language description of changes from a user perspective (max 5 sentences)',
+                  description: '1-3 sentences on practical impact',
                 },
-                technicalOnly: {
-                  type: 'boolean',
-                  description:
-                    'Whether this change is technical-only with no user-visible impact',
+                whoIsImpacted: {
+                  type: 'array',
+                  items: { type: 'string' },
+                  description: 'Audience bullets',
                 },
-                changeSize: {
-                  type: 'string',
-                  enum: ['Small', 'Medium', 'Large'],
-                  description: 'Size/scope of the change',
+                actionRequired: {
+                  type: 'array',
+                  items: { type: 'string' },
+                  description: 'Action bullets or ["No action required."]',
                 },
-                changeType: {
-                  type: 'string',
-                  enum: ['New', 'Improved', 'Fixed'],
-                  description: 'Type of change',
+                technicalDetails: {
+                  type: 'array',
+                  items: { type: 'string' },
+                  description: 'Technical detail bullets ending with Reference',
+                },
+                tags: {
+                  type: 'array',
+                  items: { type: 'string' },
+                  description: 'Approved tags',
                 },
               },
               required: [
                 'title',
                 'summary',
-                'technicalOnly',
-                'changeSize',
-                'changeType',
+                'whatsNew',
+                'whyThisMatters',
+                'whoIsImpacted',
+                'actionRequired',
+                'technicalDetails',
+                'tags',
               ],
               additionalProperties: false,
             },
@@ -464,52 +498,20 @@ export async function writeYamlFile(mainTicketId, enhancedNotes) {
       ticketId: mainTicketId,
       title: enhancedNotes.title,
       summary: enhancedNotes.summary,
-      technicalDescription: {
-        __line: enhancedNotes.technicalDescription,
-      },
-      userFacingDescription: {
-        __line: enhancedNotes.userFacingDescription,
-      },
-      technicalOnly: enhancedNotes.technicalOnly,
-      changeSize: enhancedNotes.changeSize,
-      changeType: enhancedNotes.changeType,
+      whatsNew: enhancedNotes.whatsNew,
+      whyThisMatters: enhancedNotes.whyThisMatters,
+      whoIsImpacted: enhancedNotes.whoIsImpacted,
+      actionRequired: enhancedNotes.actionRequired,
+      technicalDetails: enhancedNotes.technicalDetails,
+      tags: enhancedNotes.tags,
     },
     {
       lineWidth: -1, // Don't wrap lines
       noRefs: true,
-      schema: yaml.DEFAULT_SCHEMA.extend({
-        implicit: [
-          new yaml.Type('tag:yaml.org,2002:str', {
-            kind: 'scalar',
-            instanceOf: Object,
-            resolve: function (object) {
-              return object !== null && object['__line'];
-            },
-            predicate: function (object) {
-              return object['__line'];
-            },
-            construct: function (object) {
-              return object.__line;
-            },
-            represent: function (object) {
-              return { __line: object.__line };
-            },
-          }),
-        ],
-      }),
     },
   );
 
-  // Replace the problematic YAML output with properly formatted literal block scalars
-  const fixedYaml = yamlContent
-    .replace(/technicalDescription: '?(.*?)'?$/m, () => {
-      return `technicalDescription: |\n  ${enhancedNotes.technicalDescription.replace(/\n/g, '\n  ')}`;
-    })
-    .replace(/userFacingDescription: '?(.*?)'?$/m, () => {
-      return `userFacingDescription: |\n  ${enhancedNotes.userFacingDescription.replace(/\n/g, '\n  ')}`;
-    });
-
-  fs.writeFileSync(yamlFilePath, fixedYaml, 'utf8');
+  fs.writeFileSync(yamlFilePath, yamlContent, 'utf8');
 }
 
 export async function getReleaseNotes(ticketId) {