@docupace/pipeline 1.0.39-matttest.4 → 1.0.39-matttest.40

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,6 +1,6 @@
 {
   "name": "@docupace/pipeline",
-  "version": "1.0.39-matttest.4",
+  "version": "1.0.39-matttest.40",
   "description": "",
   "main": "index.js",
   "type": "module",
@@ -23,9 +23,11 @@
     "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",
     "openai": "^4.76.3",
+    "semver": "^7.7.2",
     "zod": "^3.24.1",
     "zx": "^8.3.0"
   },
@@ -42,6 +44,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/cli.js

@@ -1,151 +1,85 @@
 #!/usr/bin/env node
 import { Command } from 'commander';
 import { $ } from 'zx';
-import path from 'path';
 import { validateChangesets } from './validate.js';
-import fs from 'fs';
-import OpenAI from 'openai';
-import { zodResponseFormat } from 'openai/helpers/zod';
-import z from 'zod';
 import dotenv from 'dotenv';
-import { makeJiraRequest, updateComponentVersion } from '../next/jira.js';
+import { isMonoRepo, setGitInfo } from '../next/util.js';
+import { updateJiraWithVersion, versionCommand } from './version.js';
+import { createChangeset } from './create.js';
+
 dotenv.config({ path: ['.env.pipeline.local', 'config/.env.pipeline.local'] });
-import { setGitInfo } from '../next/util.js';
 
 const program = new Command();
 
 const args = process.argv;
 
-async function createChangesetDirectory() {
-  try {
-    // Use path.join to build a safe path to `.changeset`
-    const targetDir = path.join(process.cwd(), '.changeset');
+async function commitTagCommand(releases) {
+  console.log('📌 Checking for updates to commit...');
 
-    // Create the directory recursively if it doesn't exist
-    await fs.promises.mkdir(targetDir, { recursive: true });
-  } catch (error) {
-    console.error('Error creating .changeset directory:', error);
+  // Check if there are changes to commit
+  const status = (await $`git status --porcelain`).stdout.trim();
+  if (!status) {
+    console.log('✅ No changes to commit. Exiting.');
+    return;
   }
-}
-
-function run(command) {
-  return new Promise((resolve, reject) => {
-    exec(command, { shell: true }, (error, stdout, stderr) => {
-      if (error) {
-        reject(error);
-      } else {
-        resolve({ stdout, stderr });
-      }
-    });
-  });
-}
 
-async function fileExists(filePath) {
-  try {
-    await fs.promises.access(filePath);
-    return true;
-  } catch {
-    return false;
-  }
-}
+  console.log('📌 Committing and tagging the new version...');
+  await setGitInfo();
+  await $`git add .`;
 
-async function getMainPackage() {
-  const mainModulePath = process.cwd();
-  if (mainModulePath) {
-    const packageJsonPath = path.join(mainModulePath, 'package.json');
-    if (await fileExists(packageJsonPath)) {
-      const fileContent = await fs.promises.readFile(packageJsonPath, 'utf-8');
-      const packageJson = JSON.parse(fileContent);
-      return packageJson;
-    }
+  if (isMonoRepo()) {
+    await commitTagMono(releases);
+  } else {
+    await commitTag();
   }
-  throw new Error('Main package.json not found');
 }
 
-const changeSetPackage = `{
-  "name": "changeset-package",
-  "version": "1.0.0",
-  "description": "",
-  "scripts": {
-  },
-  "type": "module",
-  "keywords": [],
-  "author": "",
-  "license": "ISC",
-  "dependencies": {},
-  "devDependencies": {
-    "@changesets/cli": "^2.27.10"
-  }
+export function getAppReleases(releases) {
+  const appReleases = releases.filter((release) =>
+    release.name.endsWith('-app'),
+  );
+  return appReleases;
 }
-`;
-
-async function versionCommand(closeVersion = false) {
-  console.log('📦 Running Changeset versioning...');
-  await setGitInfo();
-  await $`mv package.json package.json.bak`;
-  await $`mv pnpm-lock.yaml pnpm-lock.yaml.bak`;
-  await fs.promises.writeFile('package.json', changeSetPackage);
-  await $`pnpm install`;
-  await $`rm package.json pnpm-lock.yaml`;
-  await $`mv package.json.bak package.json`;
-  await $`mv pnpm-lock.yaml.bak pnpm-lock.yaml`;
-  if (closeVersion) {
-    await $`pnpm changeset pre exit`;
-  }
 
-  await $`pnpm changeset version`;
+function getAppNameFromPackageName(packageName) {
+  const appName = packageName.includes('/')
+    ? packageName.split('/')[1]
+    : packageName;
 
-  // Read the updated package.json to get the new version and package name
-  const packageJson = JSON.parse(
-    await fs.promises.readFile('package.json', 'utf-8'),
-  );
-  const version = packageJson.version;
-  const packageName = packageJson.name;
+  return appName;
+}
 
-  if (closeVersion) {
-    return { version, packageName };
+async function commitTagMono(releases) {
+  let versions = [];
+  for (const release of getAppReleases(releases)) {
+    const newVersion = release.newVersion;
+    const appName = getAppNameFromPackageName(release.name);
+    versions.push(`${appName}@${newVersion}`);
   }
 
-  // Get the last commit message and extract Jira ticket
-  const lastCommit = (await $`git log -1 --pretty=%B`).stdout.trim();
-  console.log(`Last commit '${lastCommit}' being processed to get Jira ticket`);
+  const { stdout } = await $`git symbolic-ref refs/remotes/origin/HEAD`;
+  const defaultBranch = stdout.trim().replace('refs/remotes/origin/', '');
 
-  const jiraTicketMatch = lastCommit.match(/([A-Z]+-\d+)/);
-  const jiraTicketId = jiraTicketMatch ? jiraTicketMatch[0] : null;
-
-  // If we have all the necessary data, update the component version in Jira
-  if (jiraTicketId && version && packageName) {
-    try {
-      await updateComponentVersion(jiraTicketId, packageName, version);
-    } catch (error) {
-      console.error(
-        `Failed to update Jira component version: ${error.message}`,
-      );
-    }
+  await $`git commit -m "Version bump to ${versions.join(',')} and changelog"`;
+  await $`git push origin ${defaultBranch}`;
+  for (const newVersion of versions) {
+    await $`git tag ${newVersion}`;
+    console.log(`✅ Version ${newVersion} tagged.`);
   }
-
-  console.log('✅ Changeset versioning complete.');
-  return { version, packageName };
+  await $`git push origin --tags`;
+  console.log(`✅ Version pushed.`);
 }
 
-async function commitTagCommand() {
-  console.log('📌 Checking for updates to commit...');
-
-  // Check if there are changes to commit
-  const status = (await $`git status --porcelain`).stdout.trim();
-  if (!status) {
-    console.log('✅ No changes to commit. Exiting.');
-    return;
-  }
-
-  console.log('📌 Committing and tagging the new version...');
-  await setGitInfo();
-  await $`git add .`;
+async function commitTag() {
   const newVersion = (
     await $`node -p "require('./package.json').version"`
   ).stdout.trim();
+
+  const { stdout } = await $`git symbolic-ref refs/remotes/origin/HEAD`;
+  const defaultBranch = stdout.trim().replace('refs/remotes/origin/', '');
+
   await $`git commit -m "Version bump to ${newVersion} and changelog"`;
-  await $`git push origin`;
+  await $`git push origin ${defaultBranch}`;
   await $`git tag v${newVersion}`;
   await $`git push origin --tags`;
   console.log(`✅ Version ${newVersion} tagged and pushed.`);
@@ -163,7 +97,7 @@ program
     try {
       await validateChangesets();
       console.log('✅ Changeset validation passed.');
-    } catch (error) {
+    } 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',
       );
@@ -192,8 +126,9 @@ program
   .description('Run versioning and commit-and-tag in sequence')
   .action(async () => {
     console.log('📦 Running all steps...');
-    await versionCommand();
-    await commitTagCommand();
+    const releases = await versionCommand();
+    await updateJiraWithVersion(releases);
+    await commitTagCommand(releases);
   });
 
 program
@@ -201,15 +136,21 @@ program
   .description('Closes a version')
   .action(async () => {
     console.log('📦 Running all steps...');
-    const { version } = await versionCommand(true);
-    await commitTagCommand();
+    const releases = await versionCommand(true);
+    await commitTagCommand(releases);
 
-    // Get current branch
     const { stdout: currentBranch } = await $`git rev-parse --abbrev-ref HEAD`;
 
-    // Create and push release branch
-    await $`git checkout -b release/${version}`;
-    await $`git push origin release/${version}`;
+    if (isMonoRepo()) {
+      for (const release of getAppReleases(releases)) {
+        const appName = getAppNameFromPackageName(release.name);
+        await $`git checkout -b release/${appName}/${release.newVersion}`;
+        await $`git push origin release/${appName}/${release.newVersion}`;
+      }
+    } else {
+      await $`git checkout -b release/${releases[0].newVersion}`;
+      await $`git push origin release/${releases[0].newVersion}`;
+    }
 
     // Return to original branch
     await $`git checkout ${currentBranch.trim()}`;
@@ -227,100 +168,7 @@ program
     'Creates a changeset based on the current branch and Jira ticket information',
   )
   .action(async () => {
-    const mainPackage = await getMainPackage();
-    const componentName = mainPackage.name;
-
-    try {
-      // Step 1: Get the current branch name
-      const branchName = (await $`git branch --show-current`).stdout.trim();
-      console.log(`Current branch: ${branchName}`);
-
-      // Step 2: Extract Jira ticket number (e.g., matching JIRA-1234 pattern)
-      const jiraTicketMatch = branchName.match(/([A-Z]+-\d+)/);
-      if (!jiraTicketMatch) {
-        throw new Error('No Jira ticket found in the branch name.');
-      }
-      const jiraTicketId = jiraTicketMatch[0];
-
-      const jiraBaseUrl = 'https://docupacellc.atlassian.net';
-      const jiraEmail = process.env.JIRA_API_EMAIL;
-      const jiraApiKey = process.env.JIRA_API_KEY;
-      const jiraFullApiKey = `${jiraEmail}:${jiraApiKey}`;
-      const jiraUrl = `${jiraBaseUrl}/rest/api/2/issue/${jiraTicketId}`;
-      const jiraResponse = await fetch(jiraUrl, {
-        headers: {
-          Authorization: `Basic ${Buffer.from(jiraFullApiKey).toString('base64')}`,
-          'Content-Type': 'application/json',
-        },
-      });
-
-      if (!jiraResponse.ok) {
-        throw new Error(
-          `Failed to fetch Jira ticket. Status: ${jiraResponse.status}`,
-        );
-      }
-      const jiraTicketData = await jiraResponse.json();
-
-      const jiraSummary = jiraTicketData.fields.summary;
-
-      console.log(
-        `Generating release notes for ${jiraTicketId} - ${jiraSummary}`,
-      );
-
-      const openaiClient = new OpenAI({
-        apiKey: process.env['OPENAI_API_KEY'],
-      });
-
-      const ChangeRequestSchema = z.object({
-        change_type: z.enum(['patch', 'minor']),
-        summary: z.string(),
-        jira_ticket_id: z.string(),
-      });
-
-      const openAiResponse = await openaiClient.chat.completions.create({
-        model: 'gpt-4o-mini',
-        messages: [
-          {
-            role: 'system',
-            content: `Process JSON from a Jira ticket to generate simple maximum 2 sentence release note for the ticket and determine the change type for bug it should be a patch for new feature it should be a minor change`,
-          },
-          {
-            role: 'user',
-            content: JSON.stringify(jiraTicketData),
-          },
-        ],
-        response_format: zodResponseFormat(
-          ChangeRequestSchema,
-          'changeset_schema',
-        ),
-        temperature: 0,
-      });
-
-      const assistantResponse = openAiResponse.choices[0].message.content;
-      const parsedResponse = JSON.parse(assistantResponse);
-
-      const { change_type, summary } = parsedResponse;
-      console.log(`Change type: ${change_type}`);
-      console.log(`Release note: ${summary}`);
-
-      // Step 5: Create a changeset .md file
-      const changesetContent = `---
-"${componentName}": ${change_type}
----
-
-${summary} [${jiraTicketId}]
-      `;
-      const changesetFile = `./.changeset/${jiraTicketId}.md`;
-
-      await createChangesetDirectory();
-      await fs.promises.writeFile(changesetFile, changesetContent);
-      console.log(`Created changeset file at ${changesetFile}`);
-
-      console.log('Done!');
-    } catch (err) {
-      console.error(`Error: ${err.message}`);
-      process.exit(1);
-    }
+    await createChangeset();
   });
 
 // Parse arguments