Skip to content

EspoCRM – Open Source CRM Application

4.0 KB
Raw Blame
/************************************************************************
 * This file is part of EspoCRM.
 *
 * EspoCRM – Open Source CRM application.
 * Copyright (C) 2014-2026 EspoCRM, Inc.
 * Website: https://www.espocrm.com
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
 ************************************************************************/

/**
 * Builds upgrade packages.
 * From a specified version to the current version or all packages needed for a release.

 * Examples:
 * * `node diff 5.9.0` - builds an upgrade from 5.9.0 to the current version;
 * * `node diff --all` - builds all possible upgrades for the release.
 *
 * Parameters:
 * `--targetVersion` – overrides the target version.
 *
 * Data for upgrade packages is defined in `upgrades/{x.x|x.x.x-x.x.x}/data.json`.
 *
 * Data parameters:
 * - `mandatoryFiles` – {string[]} – mandatory files to include in upgrade
 *   (even files that were not changed in version control);
 * - `beforeUpgradeFiles` – {string[]} – files to copy in the beginning of the upgrade process;
 * - `manifest` – {object} – upgrade manifest parameters.
 *
 * Manifest parameters:
 * - `delete` – {string[]} – additional files to be deleted (usually those that are not in version control).
 */

const Diff = require('./js/diff');
const path = require('path');
const fs = require('fs');
const process = require('process');

const versionFrom = process.argv[2];

let acceptedVersionName = versionFrom;
let isDev = false;
let isAll = false;
let withVendor = true;
let forceScripts = false;
let isClosest = false;
let targetVersion = null;

if (process.argv.length > 1) {
    for (const i in process.argv) {
        if (process.argv[i] === '--dev') {
            isDev = true;
            withVendor = false;
        }

        if (process.argv[i] === '--all') {
            isAll = true;
        }

        if (process.argv[i] === '--no-vendor') {
            withVendor = false;
        }

        if (process.argv[i] === '--scripts') {
            forceScripts = true;
        }

        if (process.argv[i] === '--closest') {
            isClosest = true;
        }

        if (~process.argv[i].indexOf('--acceptedVersion=')) {
            acceptedVersionName = process.argv[i].substr(('--acceptedVersion=').length);
        }

        if (process.argv[i].includes('--targetVersion=')) {
            targetVersion = process.argv[i].substr(('--targetVersion=').length);
        }
    }
}

const espoPath = path.dirname(fs.realpathSync(__filename));

if (isAll || isClosest) {
    acceptedVersionName = null;
}

const diff = new Diff(espoPath, {
    isDev: isDev,
    withVendor: withVendor,
    forceScripts: forceScripts,
    acceptedVersionName: acceptedVersionName,
    targetVersion: targetVersion,
});

(() => {
    if (isAll) {
        diff.buildAllUpgradePackages();

        return;
    }

    if (isClosest) {
        diff.buildClosestUpgradePackages();

        return;
    }

    if (!versionFrom) {
        throw new Error("No 'version' specified.");
    }

    diff.buildUpgradePackage(versionFrom);
})();