@docupace/pipeline 1.0.86 → 1.0.87

package/designs/convert-to-canny.md

@@ -0,0 +1,20 @@
+#Overview
+
+Implement support for converting release notes to canny approach. This requires us to reprocess release notes from a specified version and up and generate via AI using existing functions the yaml files and then using those same yaml files upload to canny. This process is split into to parts convert-prepare, convert-complete
+
+# Implementation
+
+## convert-prepare
+
+Add to src/changeset/cli.js convert-prepare with input parameter version id which will include major and minor version
+In a new file convert.js add function convertPrepare which will perform the following logic:
+    - Process changelog MD to extract list of Jira tickets from the version specified up to the latest version. Please see example changelog /Users/fielm/Documents/Docupace/GraphQL/docupace-graphql-server/CHANGELOG.md
+    - For each Jira ticket call const { enhancedNotes, yamlFilePath, mainTicketId, summary } = await getReleaseNotes(jiraTicketId);
+    - Replace in CHANGELOG.md file the Jira ticket id [DC-XXXX] with [[${taskTicketId}]](${JIRA_BASE_URL}/browse/${taskTicketId}) [[details]](${relYamlFilePath})`;
+    - Note: do not use the summary returned by getReleaseNotes we will leave the existing summary
+
+## convert-complete
+    - Create new function similar to updateDetailsLinkInText in src/changeset/changelog.js to support multiple links
+    - Call this function passing passing fetchNewLink and contents of the changelog.md file
+    - Update the changelog.md file with the results which should have now links to canny 
+

package/package.json

@@ -1,8 +1,12 @@
 {
   "name": "@docupace/pipeline",
-  "version": "1.0.86",
+  "version": "1.0.87",
+  "description": "",
   "main": "index.js",
   "type": "module",
+  "exports": {
+    "./changelogCanny": "./src/changeset/changelog-module.cjs"
+  },
   "bin": {
     "dp-changeset-cli": "src/changeset/cli.js",
     "dp-next-cli": "src/next/cli.js",
@@ -17,9 +21,9 @@
   "license": "ISC",
   "dependencies": {
     "@changesets/cli": "^2.27.10",
-    "@docupace/core-client": "^1.0.1",
-    "@docupace/pipeline": "^1.0.12",
+    "@docupace/pipeline": "^1.0.86",
     "@jest/globals": "^30.1.2",
+    "@docupace/core-client": "^0.1.59",
     "auth0-deploy-cli": "^8.8.0",
     "axios": "^1.7.9",
     "commander": "^12.1.0",
@@ -29,6 +33,7 @@
     "inquirer": "^12.6.1",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
+    "node-fetch": "^3.3.2",
     "openai": "^4.76.3",
     "semver": "^7.7.2",
     "zod": "^3.24.1",
@@ -52,6 +57,7 @@
     "test-deploy-from-site": "dp-next-cli deploy-from-site --from-env dev --to-env dev --from-site financialdev --to-site template --deploy-core true",
     "test-run-pipline": "dp-next-cli run-pipeline -r docupace-next-e2e -b master -p run-tests-qa",
     "test-validate": "dp-changset-cli validate",
-    "test-create": "dp-changset-cli create-changeset"
+    "test-create": "dp-changset-cli create-changeset",
+    "lint:fix": "eslint --fix \"src/**/*.{js,jsx,ts,tsx}\""
   }
 }

package/src/auth0/configure.js

@@ -812,7 +812,7 @@ export async function configureFromSite(
 
   const envConfig = environmentConfig[toEnv];
 
-  let CORE_URL, SITE_HOST, CORE_API_CONTEXT, CONNECT_URL, DOCUPACE_HOST;
+  let CORE_URL, SITE_HOST, CONNECT_URL, DOCUPACE_HOST;
   const newUrl = envConfig.newUrl(toSite);
   const ccUrl = envConfig.ccUrl(toSite);
 
@@ -822,14 +822,12 @@ export async function configureFromSite(
     const newUrl = envConfig.newUrl(toSite);
     CORE_URL = `${newUrl}/core`;
     // SITE_HOST = newUrl;
-    CORE_API_CONTEXT = 'core';
     CONNECT_URL = `${newUrl}/connect`;
     DOCUPACE_HOST = envConfig.docupaceHost();
   } else {
     const oldUrl = envConfig.oldUrl(toSite);
     CORE_URL = oldUrl;
     // SITE_HOST = oldUrl;
-    CORE_API_CONTEXT = toSite;
     CONNECT_URL = `${oldUrl}_ui`;
   }
 

package/src/changeset/canny.js

@@ -0,0 +1,119 @@
+#!/usr/bin/env node
+import fetch from 'node-fetch';
+
+// Configuration
+const CANNY_API_KEY = process.env.CANNY_API_KEY;
+
+/**
+ * Upload release notes to Canny
+ * @param {Object} releaseNote - The release note data
+ * @returns {Promise<Object>} - The full Canny entry object
+ */
+export async function uploadToCanny(releaseNote, labelIDs) {
+  if (!CANNY_API_KEY) {
+    console.warn('Canny API key not provided. Skipping upload.');
+    return null;
+  }
+
+  try {
+    // Prepare the content for Canny based on the release notes
+    const title = releaseNote.title;
+    let content = '';
+
+    // 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 {
+      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';
+    }
+
+    const body = JSON.stringify({
+      apiKey: CANNY_API_KEY,
+      title: title,
+      details: content,
+      type: entryType,
+      published: false, // Keep as draft initially
+      labelIDs,
+    });
+
+    // Create a new changelog entry in Canny
+    const createResponse = await fetch(
+      'https://canny.io/api/v1/entries/create',
+      {
+        method: 'POST',
+        headers: {
+          'Content-Type': 'application/json',
+        },
+        body,
+      },
+    );
+
+    if (!createResponse.ok) {
+      console.error(`Error from Canny API: ${createResponse.statusText}`);
+      return null;
+    }
+
+    const createData = await createResponse.json();
+    const entryId = createData.id;
+
+    // Fetch the complete entry details using the entries/list endpoint
+    const listResponse = await fetch('https://canny.io/api/v1/entries/list', {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+      },
+      body: JSON.stringify({
+        apiKey: CANNY_API_KEY,
+      }),
+    });
+
+    if (!listResponse.ok) {
+      console.error(
+        `Error fetching entries list from Canny API: ${listResponse.statusText}`,
+      );
+      return createData; // Return just the create response as fallback
+    }
+
+    const listData = await listResponse.json();
+
+    // Find the entry we just created in the list
+    const fullEntry = listData.entries.find((entry) => entry.id === entryId);
+
+    if (!fullEntry) {
+      console.warn(
+        `Created entry with ID ${entryId} not found in entries list. Returning partial data.`,
+      );
+      return createData;
+    }
+
+    return fullEntry;
+  } catch (error) {
+    console.error(`Error uploading to Canny: ${error.message}`);
+    return null;
+  }
+}

package/src/changeset/changelog-module.cjs

@@ -0,0 +1,37 @@
+async function getReleaseLine(changeset, type, changelogOpts) {
+  return (async () => {
+    try {
+      const { default: changelog } = await import('./changelog.js');
+      return await changelog.getReleaseLine(changeset, type, changelogOpts);
+    } catch (e) {
+      console.error(e);
+      process.exit(1);
+    }
+    // Now you can use `changelog` here
+  })();
+}
+
+async function getDependencyReleaseLine(
+  changesets,
+  dependenciesUpdated,
+  changelogOpts,
+) {
+  return (async () => {
+    try {
+      const { default: changelog } = await import('./changelog.js');
+      return await changelog.getDependenciesReleaseLine(
+        changesets,
+        dependenciesUpdated,
+        changelogOpts,
+      ); // Now you can use `changelog` here
+    } catch (e) {
+      console.error(e);
+      process.exit(1);
+    }
+  })();
+}
+
+module.exports = {
+  getReleaseLine,
+  getDependencyReleaseLine,
+};

package/src/changeset/changelog.js

@@ -0,0 +1,210 @@
+import defaultChangeLog from '@changesets/cli/changelog';
+import { loadChangesetOutput } from './version.js';
+import path from 'path';
+import yaml from 'js-yaml';
+import { getJiraReleaseNotes, updateJiraReleaseNotes } from '../next/jira.js';
+import { uploadToCanny } from './canny.js';
+import fs from 'fs';
+import semver from 'semver';
+import { componentConfig, labelIDMap } from './config.js';
+import { findJiraTicketId } from './util.js';
+
+async function updateDetailsLinkInText(text, processDetailsLink, params) {
+  const detailsLinkRegex = /\[\[details\]\]\((.*?)\)/;
+
+  const match = text.match(detailsLinkRegex);
+  if (!match) {
+    return text; // No details link found
+  }
+
+  const originalLink = match[1];
+  const newLink = await processDetailsLink(originalLink, params);
+
+  const updatedText = text.replace(detailsLinkRegex, `[[details]](${newLink})`);
+  return updatedText;
+}
+
+/**
+ * Update multiple details links in text
+ * Similar to updateDetailsLinkInText but supports multiple [[details]](...) links
+ * @param {string} text - Text containing [[details]](link) patterns
+ * @param {Function} processDetailsLink - Function to process each link
+ * @param {Object} params - Parameters to pass to processDetailsLink
+ * @returns {Promise<string>} - Updated text with processed links
+ */
+
+function getChanges(params) {
+  const changes = params.changeset.releases.map((release) => {
+    const matchingRelease = params.output.releases.find(
+      (r) => r.name === release.name,
+    );
+
+    const version = matchingRelease ? matchingRelease.newVersion : null;
+    const parsed = version ? semver.parse(version) : null;
+
+    return {
+      name: release.name,
+      type: release.type,
+      version,
+      majorMinor: parsed ? `${parsed.major}.${parsed.minor}` : null,
+    };
+  });
+  return changes;
+}
+
+function getLabels(changes) {
+  const labels = [];
+  for (const change of changes) {
+    const componentName = componentConfig[change.name];
+    if (componentName) {
+      const labelName = componentName;
+      if (!labels.includes(labelName)) {
+        labels.push(labelName);
+      }
+    }
+  }
+  return labels;
+}
+
+function getJiraVersions(changes) {
+  const versions = [];
+  for (const change of changes) {
+    const componentName = componentConfig[change.name];
+    if (componentName) {
+      const labelName = `${componentName} - ${change.majorMinor}`;
+      if (!versions.includes(labelName)) {
+        versions.push(labelName);
+      }
+    }
+  }
+  return versions;
+}
+
+async function getLabelIDs(labels) {
+  let cannyConfig;
+  try {
+    const cannyConfigPath = path.join(
+      process.cwd(),
+      '.changeset',
+      'canny.json',
+    );
+    cannyConfig = JSON.parse(fs.readFileSync(cannyConfigPath, 'utf-8'));
+  } catch (e) {
+    console.error('Canny read canny.json file', e);
+  }
+
+  const mergedLabelMap = { ...labelIDMap, ...cannyConfig?.labels };
+  return labels.map((label) => mergedLabelMap[label]);
+}
+
+function extractSummaryDescription(text) {
+  const lines = text.split(/\r?\n/);
+
+  // Start from the 5th line (index 4)
+  const summaryLines = [];
+
+  for (let i = 0; i < lines.length; i++) {
+    if (lines[i].startsWith('[[')) {
+      break;
+    }
+    summaryLines.push(lines[i]);
+  }
+
+  return summaryLines.join('\n').trim();
+}
+
+async function fetchNewLink(oldLink, params) {
+  if (oldLink.includes('.yaml')) {
+    const normalizedOldLink = oldLink.replaceAll('\\', '/');
+    const yamlPath = path.resolve(
+      process.cwd(),
+      '.changeset',
+      normalizedOldLink,
+    );
+    const releaseNote = yaml.load(fs.readFileSync(yamlPath, 'utf-8'));
+    const ticketId = findJiraTicketId(params.changeset.id);
+    const mainTicketId = releaseNote.ticketId;
+    const summary = extractSummaryDescription(params.changeset.summary);
+    if (!ticketId) {
+      console.log('No ticket found in: ', JSON.stringify(params.changeset));
+      return;
+    }
+
+    const uploadToCannyInternal = async () => {
+      const changes = getChanges(params);
+      const jiraVersions = getJiraVersions(changes);
+      const labels = getLabels(changes);
+      const labelIDs = await getLabelIDs([...labels, ...jiraVersions]);
+      const data = await uploadToCanny(releaseNote, labelIDs);
+      return data;
+    };
+
+    const uploadToJiraInternal = async (ticketId, url) => {
+      const changes = getChanges(params);
+      const jiraVersions = getJiraVersions(changes);
+      await updateJiraReleaseNotes(ticketId, summary, url, jiraVersions);
+    };
+
+    const jiraReleaseInfo = await getJiraReleaseNotes(mainTicketId);
+    if (mainTicketId != ticketId) {
+      const subtaskJiraReleaseInfo = await getJiraReleaseNotes(ticketId);
+      if (subtaskJiraReleaseInfo?.url) {
+        return subtaskJiraReleaseInfo?.url;
+      } else {
+        if (jiraReleaseInfo?.url) {
+          await uploadToJiraInternal(ticketId, jiraReleaseInfo?.url);
+          return jiraReleaseInfo?.url;
+        } else {
+          const data = await uploadToCannyInternal();
+          await uploadToJiraInternal(ticketId, data.url);
+          await uploadToJiraInternal(mainTicketId, data.url);
+          return data.url;
+        }
+      }
+    } else {
+      if (jiraReleaseInfo?.url) {
+        return jiraReleaseInfo.url;
+      } else {
+        const data = await uploadToCannyInternal();
+        await uploadToJiraInternal(mainTicketId, data.url);
+        return data.url;
+      }
+    }
+  } else {
+    return oldLink;
+  }
+}
+
+async function uploadChangeset(changeset) {
+  const output = await loadChangesetOutput();
+  const summary = await updateDetailsLinkInText(
+    changeset.summary,
+    fetchNewLink,
+    { changeset, output },
+  );
+  return { ...changeset, summary };
+}
+
+async function getReleaseLine(changeset, type, changelogOpts) {
+  const newChangeset = await uploadChangeset(changeset);
+  return await defaultChangeLog.getReleaseLine(
+    newChangeset,
+    type,
+    changelogOpts,
+  );
+}
+
+async function getDependenciesReleaseLine(
+  changesets,
+  dependenciesUpdated,
+  changelogOpts,
+) {
+  return await defaultChangeLog.getDependencyReleaseLine(
+    changesets,
+    dependenciesUpdated,
+    changelogOpts,
+  );
+}
+
+export default { getReleaseLine, getDependenciesReleaseLine };
+export { fetchNewLink };

package/src/changeset/cli.js

@@ -10,10 +10,8 @@ import {
   versionCommand,
 } from './version.js';
 import { createChangeset } from './create.js';
-import {
-  updateWikiWithVersion,
-  upsertReleaseNotesFromFile,
-} from './changelog-wiki.js';
+import { updateWikiWithVersion } from './changelog-wiki.js';
+import { convertPrepare, convertComplete } from './convert.js';
 
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
 
@@ -93,14 +91,12 @@ async function commitTagMono(releases) {
 }
 
 async function commitTag() {
-  const newVersion = (
-    await $`node -p "require('./package.json').version"`
-  ).stdout.trim();
-
   if (process.env.IS_DEV) {
-    console.log(`Simulate commit of version ${newVersion}`);
     return;
   }
+  const newVersion = (
+    await $`node -p "require('./package.json').version"`
+  ).stdout.trim();
 
   const defaultBranch = process.env.BITBUCKET_BRANCH;
 
@@ -119,7 +115,16 @@ program
     if (!process.env.BITBUCKET_PR_ID) {
       return;
     }
-    await validateChangesets();
+    console.log('🔍 Validating changesets...');
+    try {
+      await validateChangesets();
+      console.log('✅ Changeset validation passed.');
+    } catch {
+      console.error(
+        '❌ No changeset found. Please add a changeset to this PR. Please see more information at https://docupacellc.atlassian.net/wiki/spaces/PM/pages/1350893571/Creating+changesets+for+Docupace+Next',
+      );
+      process.exit(1);
+    }
   });
 // Command: version
 program
@@ -197,40 +202,20 @@ program
     await createChangeset();
   });
 
+// Command: convert-prepare
 program
-  .command('upload-wiki')
-  .description('Upload release notes from markdown file to Confluence')
-  .requiredOption(
-    '-v, --version <version>',
-    'Version title (e.g., "Version 1.0")',
-  )
-  .requiredOption(
-    '-c, --component <component>',
-    'Component title (e.g., "Component A")',
-  )
-  .requiredOption('-f, --file <file>', 'Path to markdown file')
-  .requiredOption('-g, --group <group>', 'Group of release notes')
+  .command('convert-prepare <version> [changelogPath]')
+  .description('Convert release notes to Canny format - Part 1 (Prepare)')
+  .action(async (version, changelogPath) => {
+    await convertPrepare(version, changelogPath);
+  });
 
-  .action(async (options) => {
-    try {
-      console.log('📤 Uploading release notes to Confluence...');
-      const { versionPage, componentPage } = await upsertReleaseNotesFromFile({
-        version: options.version,
-        component: options.component,
-        markdownFile: options.file,
-        group: options.group,
-      });
-
-      console.log('✅ Successfully uploaded to Confluence');
-      console.log('Version page:', versionPage._links?.webui || versionPage.id);
-      console.log(
-        'Component page:',
-        componentPage._links?.webui || componentPage.id,
-      );
-    } catch (error) {
-      console.error('❌ Error uploading to Confluence:', error.message);
-      process.exit(1);
-    }
+// Command: convert-complete
+program
+  .command('convert-complete [changelogPath]')
+  .description('Convert release notes to Canny format - Part 2 (Complete)')
+  .action(async (changelogPath) => {
+    await convertComplete(changelogPath);
   });
 
 // Parse arguments

package/src/changeset/config.js

@@ -0,0 +1,20 @@
+export const componentConfig = {
+  '@docupace/enterprise-ui-app': 'Enterprise',
+  '@docupace/cc-ui-app': 'C & C Application',
+  '@docupace/core': 'Enterprise Core',
+  '@docupace/graphql-server': 'Enterprise',
+  '@docupace/enterprise-template': 'Enterprise',
+};
+
+export const labelIDMap = {
+  Enterprise: '6836d53ad8622b2abab1fbd9',
+  'Enterprise Core': '6836d532716bbe32f53661fb',
+  'Enterprise Core - 25.0': '68400cea3c20ce44785cca3e',
+  'Enterprise Core - 25.1': '68401502fa2d977cfcd6e102',
+  'Enterprise Core - 25.2': '6840151b0915e310b1766005',
+  'Enterprise Core - 25.3': '684018c7f11b9e5d5d24936f',
+  'Enterprise Core - 25.4': '6914853cd07d92c594ab8c61',
+  'Enterprise Core - 25.5': '691485400eb37f0c0fdf75c5',
+  'Enterprise Core - 25.6': '69148545c0a13575489d609f',
+  'Enterprise Core - 25.7': '691485fcdd3accda32e16288',
+};