@docupace/pipeline 1.0.39-matttest.9 → 1.0.39-newrelease.10

package/README.md

@@ -0,0 +1,136 @@
+# Pipeline Shared Scripts
+
+A collection of CLI tools for Docupace's CI/CD pipelines and deployment workflows.
+
+## Overview
+
+This package provides a set of command-line interfaces (CLIs) to facilitate various DevOps operations in the Docupace ecosystem:
+
+- `dp-next-cli`: Deployment and pipeline management for Next applications
+- `dp-changeset-cli`: Versioning and changeset management 
+- `dp-auth0-cli`: Auth0 tenant configuration and management
+
+## Installation
+
+```bash
+npm install @docupace/pipeline
+```
+
+Or with pnpm:
+
+```bash
+pnpm add @docupace/pipeline
+```
+
+## Command Line Interfaces
+
+### dp-next-cli
+
+Manages deployment, Docker image handling, and infrastructure configuration.
+
+```bash
+dp-next-cli [command] [options]
+```
+
+**Commands:**
+
+- `pull <imageName>`: Pull a Docker image from the registry
+- `sonar`: Run Sonar analysis
+- `addApacheSite`: Add site to apache
+- `connectClone`: Clone connect site
+- `haproxySync`: Sync haproxy config
+- `vaultAddSiteData`: Add m2m auth0 data to vault
+  - `-s, --site-name <siteName>`: Site name
+  - `-p, --site-config-remote-path <path>`: Site config remote path
+- `publish`: Publish a Docker image
+- `deploy-from-site`: Deploy an application for a specific site
+  - `-f, --from-env <fromEnv>`: Source environment
+  - `-t, --to-env <toEnv>`: Target environment
+  - `-F, --from-site <fromSite>`: Source site
+  - `-T, --to-site <toSite>`: Target site
+  - `-c, --deploy-core <deployCore>`: Deploy Core (default: "false")
+  - `-C, --deploy-connect <deployConnect>`: Deploy Connect (default: "false")
+- `deploy-template`: Deploy an application for a specific site
+- `deploy-app <application>`: Deploy an application for a specific site
+- `deploy-core <env> <site>`: Deploy Core
+  - `-l, --liquibase <liquibase>`: Application name (default: "true")
+  - `-b, --branch <branch>`: Branch (default: "master")
+- `deploy-connect <env> <site>`: Deploy Connect
+  - `-l, --liquibase <liquibase>`: Application name (default: "true")
+  - `-b, --branch <branch>`: Branch (default: "master")
+- `deploy-core-pipeline <env> <site>`: Deploy Core via pipeline
+  - `-l, --liquibase <liquibase>`: Application name (default: "true")
+  - `-b, --branch <branch>`: Branch (default: "master")
+- `copy`: Copy a Docker image between registries
+  - `-a, --application <application>`: Application name
+  - `-f, --from-env <fromEnv>`: Source environment
+  - `-t, --to-env <toEnv>`: Target environment
+  - `-g, --tag <tag>`: Image tag
+- `run-pipeline`: Trigger a pipeline by name
+  - `-r, --repository <repository>`: Repository name
+  - `-p, --pipeline-name <pipelineName>`: Pipeline name
+  - `-b, --branch <branch>`: Branch name
+  - `-v, --variables <key=value>`: Pipeline variable as key=value pair
+  - `-w, --wait`: Wait for the pipeline to complete (default: false)
+
+### dp-changeset-cli
+
+Manages versioning and changesets for mono-repos and single-package repos.
+
+```bash
+dp-changeset-cli [command] [options]
+```
+
+**Commands:**
+
+- `validate`: Validate changesets for the provided PR
+- `version`: Run Changeset versioning
+- `commit-tag`: Commit and tag the new version
+- `version-commit-tag`: Run versioning and commit-and-tag in sequence
+- `close-version`: Close a version and create a release branch
+- `create-changeset`: Create a changeset based on the current branch and Jira ticket information
+
+### dp-auth0-cli
+
+Manages Auth0 tenant configuration across environments.
+
+```bash
+dp-auth0-cli [command] [options]
+```
+
+**Commands:**
+
+- `configureFromSite <fromSite> <toSite> <fromEnv> <toEnv> <deployUI> <deployGraphQLServer> <useNewDomain> <useS3>`: Configure Auth0 tenants
+- `getVaultSecrets <vaultPath>`: Get secrets from Vault
+- `configureAlias <site> <env> <username> <password> <realm>`: Configure Core Alias for the given site
+- `exportConf <site> <env>`: Export Auth0 configuration for the given site
+- `getAuth0Metadata <site> <env>`: Get Auth0 metadata for the given site
+
+## Environment Configuration
+
+The CLI tools look for environment configuration in the following locations:
+- `.env.pipeline.local`
+- `config/.env.pipeline.local`
+
+## Examples
+
+```bash
+# Deploy from one site to another
+dp-next-cli deploy-from-site --from-env dev --to-env dev --from-site financialdev --to-site template --deploy-core true
+
+# Run a pipeline
+dp-next-cli run-pipeline -r docupace-next-e2e -b master -p run-tests-qa
+
+# Validate changesets
+dp-changeset-cli validate
+
+# Create a new changeset
+dp-changeset-cli create-changeset
+
+# Configure Auth0 for a site
+dp-auth0-cli configureFromSite sourceSite targetSite dev prod true true true false
+```
+
+## License
+
+ISC

package/next/execute.sh

@@ -53,8 +53,14 @@ copy() {
 }
 
 publish() {
-    BUILD_IMAGE_NAME="${BITBUCKET_REPO_SLUG}:build-${BITBUCKET_BUILD_NUMBER}"
-    IMAGE_NAME="${BITBUCKET_REPO_SLUG}:sha-${GIT_SHA}"
+    SLUG_SUFFIX=""
+    if [ -n "$APP_NAME" ]; then
+      SLUG_SUFFIX="-${APP_NAME}"
+    fi
+
+    BUILD_IMAGE_NAME="${BITBUCKET_REPO_SLUG}${SLUG_SUFFIX}:build-${BITBUCKET_BUILD_NUMBER}"
+    IMAGE_NAME="${BITBUCKET_REPO_SLUG}${SLUG_SUFFIX}:sha-${GIT_SHA}"
+
     export DOCKER_HOST=""
 
     echo "Publishing Docker image ${IMAGE_NAME}..."

package/package.json

@@ -1,9 +1,12 @@
 {
   "name": "@docupace/pipeline",
-  "version": "1.0.39-matttest.9",
+  "version": "1.0.39-newrelease.10",
   "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,15 +20,17 @@
   "dependencies": {
     "@changesets/cli": "^2.27.10",
     "@docupace/core-client": "^0.1.59",
-    "@docupace/pipeline": "^1.0.33-alpha-2",
     "auth0-deploy-cli": "^8.8.0",
     "axios": "^1.7.9",
     "commander": "^12.1.0",
     "dotenv": "^16.4.7",
     "fs-extra": "^11.3.0",
+    "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",
     "zx": "^8.3.0"
   },
@@ -42,6 +47,7 @@
     "test-deploy-core": "dp-next-cli deploy-core-pipeline dev template",
     "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-validate": "dp-changset-cli validate",
+    "test-create": "dp-changset-cli create-changeset"
   }
 }

package/src/auth0/configure.js

@@ -5,16 +5,16 @@ import crypto from 'crypto';
 
 import {
   cloneEnvRepository,
-  readDeployConfig,
-  pushDeployConfig,
   cloneRepository,
+  pushDeployConfig,
+  readDeployConfig,
 } from '../next/deploy.js';
 
 import { getVaultSecrets, updateVaultSecrets } from './vault.js';
 import {
-  getVaultSecretsConfigs,
-  environmentConfig,
   coreSiteEnvMap,
+  environmentConfig,
+  getVaultSecretsConfigs,
 } from '../next/config.js';
 
 async function ensureDirectoryExists(dirPath) {

package/src/auth0/metadata.js

@@ -1,11 +1,10 @@
 import fs from 'fs-extra';
 import axios from 'axios';
 import path from 'path';
-import { cloneRepository } from '../next/deploy.js';
+import { cloneRepository, pushDeployConfig } from '../next/deploy.js';
 import { getAuth0AuthToken } from './configure.js';
 import { getVaultSecrets } from './vault.js';
 import { getVaultSecretsConfigs } from '../next/config.js';
-import { pushDeployConfig } from '../next/deploy.js';
 
 export async function getAuth0Metadata(site, env) {
   try {

package/src/changeset/canny.js

@@ -0,0 +1,116 @@
+#!/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.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';
+    }
+
+    // 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: JSON.stringify({
+          apiKey: CANNY_API_KEY,
+          title: title,
+          details: content,
+          type: entryType,
+          published: false, // Keep as draft initially
+          labelIDs,
+        }),
+      },
+    );
+
+    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,26 @@
+async function getReleaseLine(changeset, type, changelogOpts) {
+  return (async () => {
+    const { default: changelog } = await import('./changelog.js');
+    return await changelog.getReleaseLine(changeset, type, changelogOpts); // Now you can use `changelog` here
+  })();
+}
+
+async function getDependencyReleaseLine(
+  changesets,
+  dependenciesUpdated,
+  changelogOpts,
+) {
+  return (async () => {
+    const { default: changelog } = await import('./changelog.js');
+    return await changelog.getDependenciesReleaseLine(
+      changesets,
+      dependenciesUpdated,
+      changelogOpts,
+    ); // Now you can use `changelog` here
+  })();
+}
+
+module.exports = {
+  getReleaseLine,
+  getDependencyReleaseLine,
+};

package/src/changeset/changelog.js

@@ -0,0 +1,139 @@
+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';
+
+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;
+}
+
+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;
+}
+
+function getLabelIDs(labels) {
+  return labels.map((label) => labelIDMap[label]);
+}
+
+async function fetchNewLink(oldLink, params) {
+  if (oldLink.includes('.yaml')) {
+    const normalizedOldLink = path.normalize(oldLink);
+    const yamlPath = path.resolve(
+      process.cwd(),
+      '.changeset',
+      normalizedOldLink,
+    );
+    const releaseNote = yaml.load(fs.readFileSync(yamlPath, 'utf-8'));
+    const jiraReleaseInfo = await getJiraReleaseNotes(releaseNote.ticketId);
+    if (jiraReleaseInfo?.url) {
+      return jiraReleaseInfo.url;
+    } else {
+      const changes = getChanges(params);
+      const labels = getLabels(changes);
+      const labelIDs = getLabelIDs(labels);
+      const jiraVersions = getJiraVersions(changes);
+      const data = await uploadToCanny(releaseNote, labelIDs);
+      await updateJiraReleaseNotes(
+        releaseNote.ticketId,
+        releaseNote.summary,
+        data.url,
+        jiraVersions,
+      );
+      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 };