Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 11x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 6x 6x 6x 6x 6x 6x 6x 6x 6x 6x 1x 1x 6x 6x 6x 6x 6x 6x 6x 6x 11x 11x 10x 10x 10x 10x 10x 10x 10x 9x 10x 1x 1x 10x 11x 11x 11x 11x 6x 6x 6x 6x 6x 6x 6x 4x 4x 4x 4x 4x 3x 3x 3x 3x 3x 3x 3x 3x 4x 4x 4x 4x 4x 6x 3x 3x 6x 3x 3x 6x 3x 3x 6x 6x 6x 1x 6x 1x 1x 1x 1x 1x 1x 5x 4x 4x 6x 6x 6x 1x 1x 1x | "use strict";
/**
* @module rtk
*/
import async from "async";
import bag from "bagofcli";
import util from "util";
import rtkReleaseScheme from "./release-schemes/rtk.js";
import hclResourceType from "./resource-types/hcl.js";
import jsonResourceType from "./resource-types/json.js";
import keepAChangelogResourceType from "./resource-types/keep-a-changelog.js";
import makefileResourceType from "./resource-types/makefile.js";
import textResourceType from "./resource-types/text.js";
import tomlResourceType from "./resource-types/toml.js";
import xmlResourceType from "./resource-types/xml.js";
import yamlResourceType from "./resource-types/yaml.js";
/**
* RTK is the enchilada, Release The Kraken!
*/
class RTK {
/**
* Construct RTK object which will manage a set of resources.
*
* @param {Array<Object>} resources - resources which contain version value,
* the first resource is used as the source of truth of current version
* @param {Object} [opts] - optional settings
* @param {Boolean} [opts.dryRun] - when true, no change will be made
* @param {String} [opts.releaseIncrementType] - major, minor, or patch
* @param {String} [opts.postReleaseIncrementType] - major, minor, or patch
* @param {String} [opts.tagFormat] - SCM tag format, e.g. v{version}
*/
constructor(resources, opts) {
this.resources = resources || {};
this.opts = opts || {};
this.releaseSchemes = {
rtk: rtkReleaseScheme,
};
this.resourceTypes = {
hcl: hclResourceType,
json: jsonResourceType,
makefile: makefileResourceType,
text: textResourceType,
toml: tomlResourceType,
xml: xmlResourceType,
yaml: yamlResourceType,
};
this.resourceTypes["keep-a-changelog"] = keepAChangelogResourceType;
}
/**
* Execute release steps for the specified release scheme, when all
* resources are ready for release. When a resource is not ready for
* release, e.g. a changelog without unreleased changes, the release fails
* with an error before any change is made.
*
* @param {String} [releaseSchemeName=rtk] - release scheme name that
* defines the steps involved in a release
* @param {String} [versionSchemeName=semver] - version scheme name that
* defines the release and post-release version values
* @param {String} [scmSchemeName=git] - name of SCM used by the repository
* to be released
* @param {Function} cb - standard cb(err, result) callback
*/
release(releaseSchemeName, versionSchemeName, scmSchemeName, cb) {
const self = this;
releaseSchemeName = releaseSchemeName || "rtk";
versionSchemeName = versionSchemeName || "semver";
scmSchemeName = scmSchemeName || "git";
let releaseScheme;
const logOpts = {};
if (self.opts.dryRun) {
logOpts["labels"] = ["dry run"];
}
function readyTask(cb) {
bag.logStepHeading(
"Checking resources are ready for release...",
logOpts,
);
function resourceTask(resource, cb) {
function readyCb(err, ready) {
if (!err) {
const message = util.format(
"%s resource located at %s is %s for release",
resource.type,
resource.path,
ready ? "ready" : "not ready",
);
if (ready) {
bag.logStepItemSuccess(message, logOpts);
} else {
bag.logStepItemWarning(message, logOpts);
}
}
cb(err, ready);
}
self.resourceTypes[resource.type].isReadyForRelease(resource, readyCb);
}
function resourcesCb(err, results) {
cb(err, !err && results.every((ready) => ready));
}
async.mapSeries(self.resources, resourceTask, resourcesCb);
}
function versionTask(cb) {
// uses first resource as the source of truth and the correct pre-release version
const preReleaseResource = self.resources[0];
function versionCb(err, result) {
if (!err) {
const ReleaseSchemeClass = self.releaseSchemes[releaseSchemeName];
releaseScheme = new ReleaseSchemeClass(
versionSchemeName,
scmSchemeName,
result,
self.opts,
);
}
cb(err, result);
}
const resourceType = self.resourceTypes[preReleaseResource.type];
resourceType.getVersion(preReleaseResource, versionCb);
}
function preTask(cb) {
releaseScheme.pre(self.resources, self.opts, cb);
}
function releaseTask(cb) {
releaseScheme.release(self.resources, self.opts, cb);
}
function postTask(cb) {
releaseScheme.post(self.resources, self.opts, cb);
}
function readyTaskCb(err, ready) {
if (err) {
cb(err);
} else if (!ready) {
// fail instead of skip, so release pipelines don't pass silently when there's nothing to release
cb(
new Error(
"Release failed because not all resources are ready for release",
),
);
} else {
async.series([versionTask, preTask, releaseTask, postTask], cb);
}
}
readyTask(readyTaskCb);
}
}
export { RTK as default };
|