@oneblink/release-cli 3.0.1 → 3.1.0-beta.1

package/dist/bin.js

@@ -10,6 +10,7 @@ import getPreRelease from './getPreRelease.js';
 import startProductRelease from './startProductRelease.js';
 import promptForReleaseName from './promptForReleaseName.js';
 import getRepositoryPlugin from './repositories-plugins/plugins-factory.js';
+import startUpdateDependents from './startUpdateDependents.js';
 const cli = meow(`
 ${chalk.bold.blue('oneblink-release product [--name]')}
 
@@ -51,6 +52,17 @@ ${chalk.bold('Examples')}
   oneblink-release repository 1.1.1
   oneblink-release repository 1.1.1 --cwd ../path/to/code
   oneblink-release repository 1.1.1-uat.1 --no-git
+
+${chalk.grey('Update all product code bases that depend on an NPM package.')}
+
+  --cwd .......... Directory of the repository that is the dependency relative
+                   to the current working directory, defaults to the current
+                   working directory.
+
+${chalk.bold('Examples')}
+
+  oneblink-release update-dependents
+  oneblink-release update-dependents --cwd ../path/to/code
 `, {
     importMeta: import.meta,
     flags: {
@@ -99,7 +111,14 @@ run().catch((error) => {
 });
 async function run() {
     const command = cli.input[0];
+    const cwd = path.resolve(process.cwd(), cli.flags.cwd);
     switch (command) {
+        case 'update-dependents': {
+            await startUpdateDependents({
+                cwd,
+            });
+            break;
+        }
         case 'product': {
             const releaseName = cli.flags.name || (await promptForReleaseName());
             await startProductRelease({ releaseName });
@@ -108,7 +127,7 @@ async function run() {
         case 'repository': {
             let input = cli.input[1];
             const repositoryPlugin = await getRepositoryPlugin({
-                cwd: path.resolve(process.cwd(), cli.flags.cwd),
+                cwd,
             });
             if (!semver.valid(input)) {
                 const { nextVersion } = await promptForNextVersion({

package/dist/enumerateProductRepositories.js

@@ -0,0 +1,138 @@
+import path from 'path';
+import prepareCloneRepository from './prepareCloneRepository.js';
+const productRepositories = [
+    {
+        label: '@oneblink/apps (NPM package)',
+        repositoryName: 'apps',
+        type: 'NPM',
+        isPublic: true,
+    },
+    {
+        label: '@oneblink/apps-react (NPM package)',
+        repositoryName: 'apps-react',
+        type: 'NPM',
+        isPublic: true,
+    },
+    {
+        label: '@oneblink/cli (NPM package)',
+        repositoryName: 'cli',
+        isPublic: true,
+        type: 'NPM',
+    },
+    {
+        label: 'Embedded Forms Script',
+        repositoryName: 'forms-cdn',
+        isPublic: true,
+        type: 'CDN_HOSTING',
+    },
+    {
+        label: 'API',
+        repositoryName: 'product-api',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Approvals API',
+        repositoryName: 'product-approvals-api',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Approvals Client',
+        repositoryName: 'product-approvals-client',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Cognito Hosted Login CSS',
+        repositoryName: 'product-cognito-hosted-login-css',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Console',
+        repositoryName: 'product-console',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Data Manager Client',
+        repositoryName: 'product-form-store-client',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Lambda@Edge Functions',
+        repositoryName: 'product-forms-lambda-at-edge-authorisation',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Forms Renderer',
+        repositoryName: 'product-forms-renderer',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Infrastructure',
+        repositoryName: 'product-infrastructure',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'PDF Service',
+        repositoryName: 'product-pdf',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'S3 Submission Events Lambda(s)',
+        repositoryName: 'product-s3-submission-events',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: 'Volunteers Client',
+        repositoryName: 'product-volunteers-client',
+        isPublic: false,
+        type: 'NODE_JS',
+    },
+    {
+        label: '@oneblink/sdk-core (NPM package)',
+        repositoryName: 'sdk-core-js',
+        isPublic: true,
+        type: 'NPM',
+    },
+    {
+        label: 'OneBlink.SDK (Nuget package)',
+        repositoryName: 'sdk-dotnet',
+        isPublic: true,
+        type: 'NUGET',
+        relativeProjectFile: path.join('OneBlink.SDK', 'OneBlink.SDK.csproj'),
+    },
+    {
+        label: '@oneblink/sdk (NPM package)',
+        repositoryName: 'sdk-node-js',
+        isPublic: true,
+        type: 'NPM',
+    },
+];
+export default async function enumerateProductRepositories(fn) {
+    for (const productRepository of productRepositories) {
+        const { repositoryName } = productRepository;
+        const { cloneRepository, repositoryWorkingDirectory, removeRepositoryWorkingDirectory, } = await prepareCloneRepository({
+            repositoryName,
+        });
+        try {
+            const cloneUrl = await cloneRepository();
+            await fn({
+                cloneUrl,
+                repositoryWorkingDirectory,
+                productRepository,
+            });
+        }
+        finally {
+            await removeRepositoryWorkingDirectory();
+        }
+    }
+}

package/dist/prepareCloneRepository.js

@@ -0,0 +1,35 @@
+import { mkdtemp, rm } from 'fs/promises';
+import { join } from 'node:path';
+import { tmpdir } from 'node:os';
+import executeCommand from './executeCommand.js';
+import wrapWithLoading from './wrapWithLoading.js';
+export default async function prepareCloneRepository({ repositoryName, }) {
+    const repositoryWorkingDirectory = await wrapWithLoading({
+        startText: `Creating temporary directory to clone "${repositoryName}"`,
+        failText: `Failed to create temporary directory to clone "${repositoryName}"`,
+    }, async (spinner) => {
+        const directory = await mkdtemp(join(tmpdir(), repositoryName));
+        spinner.succeed(`Created temporary directory to clone "${repositoryName}"`);
+        return directory;
+    });
+    return {
+        repositoryWorkingDirectory,
+        async cloneRepository() {
+            const cloneUrl = `git@github.com:oneblink/${repositoryName}.git`;
+            await executeCommand('git', ['clone', cloneUrl, repositoryWorkingDirectory], '.');
+            return cloneUrl;
+        },
+        async removeRepositoryWorkingDirectory() {
+            await wrapWithLoading({
+                startText: `Removing temporary directory for "${repositoryName}"`,
+                failText: `Failed to remove temporary directory for "${repositoryName}"`,
+            }, async (spinner) => {
+                await rm(repositoryWorkingDirectory, {
+                    recursive: true,
+                    force: true,
+                });
+                spinner.succeed(`Removed temporary directory for "${repositoryName}"`);
+            });
+        },
+    };
+}

package/dist/repositories-plugins/NpmPlugin.js

@@ -4,6 +4,7 @@ import executeCommand from '../executeCommand.js';
 export default class NpmPlugin {
     displayType = 'NPM';
     isDeploymentRequired = false;
+    supportsDependencyUpdates = true;
     cwd;
     constructor({ cwd }) {
         this.cwd = cwd;

package/dist/repositories-plugins/NugetPlugin.js

@@ -3,6 +3,7 @@ import path from 'path';
 import getPreRelease from '../getPreRelease.js';
 export default class NugetPlugin {
     isDeploymentRequired = false;
+    supportsDependencyUpdates = false;
     displayType = 'Nuget';
     cwd;
     relativeProjectFile;

package/dist/startProductRelease.js

@@ -1,201 +1,75 @@
-import { mkdtemp, rm } from 'fs/promises';
-import { join } from 'node:path';
-import { tmpdir } from 'node:os';
 import enquirer from 'enquirer';
 import executeCommand from './executeCommand.js';
 import parseChangelogWithLoading from './parseChangelogWithLoading.js';
 import promptForNextVersion from './promptForNextVersion.js';
 import boxen from 'boxen';
 import chalk from 'chalk';
-import wrapWithLoading from './wrapWithLoading.js';
 import startRepositoryRelease from './startRepositoryRelease.js';
-import path from 'path';
 import getRepositoryPlugin from './repositories-plugins/plugins-factory.js';
-const gitCloneRepositories = [
-    {
-        repositoryName: 'apps',
-        type: 'NPM',
-        isPublic: true,
-    },
-    {
-        repositoryName: 'apps-react',
-        type: 'NPM',
-        isPublic: true,
-    },
-    {
-        repositoryName: 'cli',
-        isPublic: true,
-        type: 'NPM',
-    },
-    {
-        repositoryName: 'forms-cdn',
-        isPublic: true,
-        type: 'CDN_HOSTING',
-    },
-    {
-        repositoryName: 'product-api',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-approvals-api',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-approvals-client',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-cognito-hosted-login-css',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-console',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-form-store-client',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-forms-lambda-at-edge-authorisation',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-forms-renderer',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-infrastructure',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-pdf',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-s3-submission-events',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'product-volunteers-client',
-        isPublic: false,
-        type: 'NODE_JS',
-    },
-    {
-        repositoryName: 'sdk-core-js',
-        isPublic: true,
-        type: 'NPM',
-    },
-    {
-        repositoryName: 'sdk-dotnet',
-        isPublic: true,
-        type: 'NUGET',
-        relativeProjectFile: path.join('OneBlink.SDK', 'OneBlink.SDK.csproj'),
-    },
-    {
-        repositoryName: 'sdk-node-js',
-        isPublic: true,
-        type: 'NPM',
-    },
-];
+import enumerateProductRepositories from './enumerateProductRepositories.js';
 export default async function startProductRelease({ releaseName, }) {
     console.log('Beginning Product release process for:', releaseName);
     const deploymentRequiredUrls = [];
-    for (const gitCloneRepository of gitCloneRepositories) {
-        const { repositoryName } = gitCloneRepository;
-        const repositoryWorkingDirectory = await wrapWithLoading({
-            startText: `Creating temporary directory to clone "${repositoryName}"`,
-            failText: `Failed to create temporary directory to clone "${repositoryName}"`,
-        }, async (spinner) => {
-            const directory = await mkdtemp(join(tmpdir(), repositoryName));
-            spinner.succeed(`Created temporary directory to clone "${repositoryName}"`);
-            return directory;
-        });
-        try {
-            const cloneUrl = `git@github.com:oneblink/${repositoryName}.git`;
-            await executeCommand('git', ['clone', cloneUrl, repositoryWorkingDirectory], '.');
-            // Check if repository needs releasing
-            const { parsedChangelog } = await parseChangelogWithLoading(repositoryWorkingDirectory);
-            const unreleasedVersion = parsedChangelog.versions.find((version) => version.title.toLowerCase().includes('unreleased'));
-            if (!unreleasedVersion) {
-                await continuePromptWithWarning(`"${repositoryName}" CHANGELOG.md does not contain an "Unreleased" section
+    await enumerateProductRepositories(async ({ productRepository, cloneUrl, repositoryWorkingDirectory }) => {
+        const { repositoryName } = productRepository;
+        // Check if repository needs releasing
+        const { parsedChangelog } = await parseChangelogWithLoading(repositoryWorkingDirectory);
+        const unreleasedVersion = parsedChangelog.versions.find((version) => version.title.toLowerCase().includes('unreleased'));
+        if (!unreleasedVersion) {
+            await continuePromptWithWarning(`"${repositoryName}" CHANGELOG.md does not contain an "Unreleased" section
 
 You need to checkout "${cloneUrl}" to fix this before trying again.`);
-                continue;
-            }
-            const { stdout: lastCommitMessage } = await executeCommand('git', ['log', '-1', '--pretty=oneline'], repositoryWorkingDirectory);
-            const unreleasedChangelogEntries = unreleasedVersion.body.trim() ||
-                chalk.italic('There are no entries under the "Unreleased" heading.');
-            console.log(boxen(chalk.blue(`${unreleasedChangelogEntries}
+            return;
+        }
+        const { stdout: lastCommitMessage } = await executeCommand('git', ['log', '-1', '--pretty=oneline'], repositoryWorkingDirectory);
+        const unreleasedChangelogEntries = unreleasedVersion.body.trim() ||
+            chalk.italic('There are no entries under the "Unreleased" heading.');
+        console.log(boxen(chalk.blue(`${unreleasedChangelogEntries}
           
 Last Commit: ${lastCommitMessage}`), {
-                title: 'Unreleased Entries',
-                padding: 1,
-                margin: {
-                    top: 1,
-                    bottom: 1,
+            title: 'Unreleased Entries',
+            padding: 1,
+            margin: {
+                top: 1,
+                bottom: 1,
+            },
+        }));
+        const { isReleasing } = await enquirer.prompt({
+            type: 'select',
+            name: 'isReleasing',
+            message: `Would you like to release "${repositoryName}"? See unreleased section from changelog above to decide.`,
+            choices: [
+                {
+                    message: `No! "${repositoryName}" does not need to be released.`,
+                    name: 'no',
+                },
+                {
+                    message: 'Yes, release away!',
+                    name: 'yes',
                 },
-            }));
-            const { isReleasing } = await enquirer.prompt({
-                type: 'select',
-                name: 'isReleasing',
-                message: `Would you like to release "${repositoryName}"? See unreleased section from changelog above to decide.`,
-                choices: [
-                    {
-                        message: `No! "${repositoryName}" does not need to be released.`,
-                        name: 'no',
-                    },
-                    {
-                        message: 'Yes, release away!',
-                        name: 'yes',
-                    },
-                ],
-            });
-            if (isReleasing === 'no') {
-                continue;
-            }
-            const repositoryPlugin = await getRepositoryPlugin({
-                cwd: repositoryWorkingDirectory,
-                repositoryType: gitCloneRepository,
-            });
-            const { nextVersion } = await promptForNextVersion({
-                repositoryPlugin,
-                noPreRelease: true,
-            });
-            await startRepositoryRelease({
-                nextVersion,
-                git: true,
-                releaseName: gitCloneRepository.isPublic ? undefined : releaseName,
-                repositoryPlugin,
-            });
-            if (repositoryPlugin.isDeploymentRequired) {
-                deploymentRequiredUrls.push(`https://github.com/oneblink/${repositoryName}/actions`);
-            }
+            ],
+        });
+        if (isReleasing === 'no') {
+            return;
         }
-        finally {
-            await wrapWithLoading({
-                startText: `Removing temporary directory for "${repositoryName}"`,
-                failText: `Failed to remove temporary directory for "${repositoryName}"`,
-            }, async (spinner) => {
-                await rm(repositoryWorkingDirectory, {
-                    recursive: true,
-                    force: true,
-                });
-                spinner.succeed(`Removed temporary directory for "${repositoryName}"`);
-            });
+        const repositoryPlugin = await getRepositoryPlugin({
+            cwd: repositoryWorkingDirectory,
+            repositoryType: productRepository,
+        });
+        const { nextVersion } = await promptForNextVersion({
+            repositoryPlugin,
+            noPreRelease: true,
+        });
+        await startRepositoryRelease({
+            nextVersion,
+            git: true,
+            releaseName: productRepository.isPublic ? undefined : releaseName,
+            repositoryPlugin,
+        });
+        if (repositoryPlugin.isDeploymentRequired) {
+            deploymentRequiredUrls.push(`https://github.com/oneblink/${repositoryName}/actions`);
         }
-    }
+    });
     console.log(boxen(chalk.green('Product Release Complete!!!'), {
         padding: 1,
     }));

package/dist/startRepositoryRelease.js

@@ -1,5 +1,4 @@
 import fs from 'fs';
-import path from 'path';
 import util from 'util';
 import prettier from 'prettier';
 import semver from 'semver';
@@ -8,7 +7,6 @@ import wrapWithLoading from './wrapWithLoading.js';
 import executeCommand from './executeCommand.js';
 import parseChangelogWithLoading from './parseChangelogWithLoading.js';
 import getPreRelease from './getPreRelease.js';
-const readFileAsync = util.promisify(fs.readFile);
 const writeFileAsync = util.promisify(fs.writeFile);
 const UNRELEASED_VERSION_INDEX = 0;
 const GIT_TAG_PREFIX = 'v';
@@ -68,14 +66,6 @@ ${dependenciesChangelog.entries}
         startText: `Updating CHANGELOG.md with next release (${nextReleaseTitle})`,
         failText: `Failed to update CHANGELOG.md with next release (${nextReleaseTitle})`,
     }, async (spinner) => {
-        let prettierOptions = {};
-        try {
-            const s = await readFileAsync(path.join(repositoryPlugin.cwd, '.prettierrc'), 'utf-8');
-            prettierOptions = JSON.parse(s);
-        }
-        catch (error) {
-            // ignore errors attempting to find prettier configuration
-        }
         const changelog = await prettier.format(`
 # ${parsedChangelog.title}
 
@@ -101,7 +91,6 @@ ${body}
 `;
         })
             .join('')}`, {
-            ...prettierOptions,
             parser: 'markdown',
         });
         await writeFileAsync(changelogPath, changelog, 'utf-8');

package/dist/startUpdateDependents.js

@@ -0,0 +1,95 @@
+import { readPackageUp } from 'read-package-up';
+import enumerateProductRepositories from './enumerateProductRepositories.js';
+import getRepositoryPlugin from './repositories-plugins/plugins-factory.js';
+import enquirer from 'enquirer';
+import executeCommand from './executeCommand.js';
+import boxen from 'boxen';
+export default async function startUpdateDependents({ cwd }) {
+    const dependencyRepositoryPlugin = await getRepositoryPlugin({
+        cwd,
+    });
+    if (!dependencyRepositoryPlugin.supportsDependencyUpdates) {
+        console.log(`"${dependencyRepositoryPlugin.displayType}" repositories do not support updating dependencies.`);
+        return;
+    }
+    const dependencyResult = await readPackageUp({
+        cwd,
+    });
+    if (!dependencyResult) {
+        return;
+    }
+    const dependency = dependencyResult.packageJson.name;
+    console.log('Beginning to update the dependents of:', dependency);
+    const { jiraTicket } = await enquirer.prompt({
+        type: 'input',
+        name: 'jiraTicket',
+        message: `JIRA ticket to associate with pull requests? (e.g. ON-4323)`,
+        required: true,
+        validate: (input) => {
+            if (!/^ON-\d+$/.test(input)) {
+                return 'JIRA ticket must be "ON-" followed by a number';
+            }
+            return true;
+        },
+    });
+    const createPullRequestUrls = [];
+    await enumerateProductRepositories(async ({ productRepository, repositoryWorkingDirectory }) => {
+        const repositoryPlugin = await getRepositoryPlugin({
+            cwd: repositoryWorkingDirectory,
+            repositoryType: productRepository,
+        });
+        if (!repositoryPlugin.supportsDependencyUpdates) {
+            console.log(`Skipping "${productRepository.repositoryName}" as "${repositoryPlugin.displayType}" does not support updating dependencies.`);
+            return;
+        }
+        const result = await readPackageUp({
+            cwd: repositoryWorkingDirectory,
+        });
+        const currentDependencyVersion = result?.packageJson.dependencies?.[dependency];
+        if (!currentDependencyVersion) {
+            console.log(`Skipping "${productRepository.repositoryName}" as it does not contain "${dependency}" as a dependency.`);
+            return;
+        }
+        if (currentDependencyVersion === `^${dependencyResult.packageJson.version}`) {
+            console.log(`Skipping "${productRepository.repositoryName}" as it's version of "${dependency}" is already "${currentDependencyVersion}".`);
+            return;
+        }
+        const { isUpdating } = await enquirer.prompt({
+            type: 'select',
+            name: 'isUpdating',
+            message: `Would you like to update "${dependency}" in "${productRepository.repositoryName}" (${currentDependencyVersion} > ${dependencyResult.packageJson.version})?`,
+            choices: [
+                {
+                    message: 'Yes, update dependency!',
+                    name: 'yes',
+                },
+                {
+                    message: `No! "${productRepository.repositoryName}" does not need to be updated.`,
+                    name: 'no',
+                },
+            ],
+        });
+        if (isUpdating === 'no') {
+            return;
+        }
+        await executeCommand('git', ['checkout', '-b', jiraTicket], repositoryWorkingDirectory);
+        await executeCommand('npm', [
+            'install',
+            '--package-lock-only',
+            '--save',
+            `${dependency}@${dependencyResult.packageJson.version}`,
+        ], repositoryWorkingDirectory);
+        await executeCommand('git', ['add', '-A'], repositoryWorkingDirectory);
+        await executeCommand('git', ['commit', '--message', `${jiraTicket} # Bumped ${dependency}`], repositoryWorkingDirectory);
+        await executeCommand('git', ['push', '-u', 'origin', jiraTicket], repositoryWorkingDirectory);
+        createPullRequestUrls.push(`https://github.com/oneblink/${productRepository.repositoryName}/pull/new/${jiraTicket}`);
+    });
+    if (createPullRequestUrls.length) {
+        console.log(boxen(`The following Pull Requests can be created:
+
+  ${createPullRequestUrls.join(`
+  `)}`, {
+            padding: 1,
+        }));
+    }
+}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@oneblink/release-cli",
   "description": "Used internally by OneBlink to release repositories quickly and consistently",
-  "version": "3.0.1",
+  "version": "3.1.0-beta.1",
   "author": "OneBlink <developers@oneblink> (https://github.com/oneblink)",
   "bin": {
     "oneblink-release": "dist/bin.js"