projen
Version:
CDK for software projects
94 lines • 12.3 kB
JavaScript
;
var _a;
Object.defineProperty(exports, "__esModule", { value: true });
exports.ReleaseTrigger = void 0;
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
/**
* Used to manage release strategies. This includes release
* and release artifact automation
*/
class ReleaseTrigger {
/**
* Creates a manual release trigger.
*
* Use this option if you want totally manual releases.
*
* This will give you a release task that, in addition to the normal
* release activities will trigger a `publish:git` task. This task will
* handle project-level changelog management, release tagging, and pushing
* these artifacts to origin.
*
* The command used for pushing can be customised by specifying
* `gitPushCommand`. Set to an empty string to disable pushing entirely.
*
* Simply run `yarn release` to trigger a manual release.
*
* @param options release options
*/
static manual(options = {}) {
let changelogPath;
if (options.changelog ?? true) {
changelogPath = options.changelogPath ?? "CHANGELOG.md";
}
return new ReleaseTrigger({
changelogPath: changelogPath,
gitPushCommand: options.gitPushCommand,
});
}
/**
* Creates a scheduled release trigger.
*
* Automated releases will occur based on the provided cron schedule.
*
* @param options release options.
*/
static scheduled(options) {
return new ReleaseTrigger({
schedule: options.schedule,
});
}
/**
* The release can only be triggered using the GitHub UI.
*/
static workflowDispatch() {
// This works because every workflow is always automatically `workflowDispatch`able
//
// The only thing we need to ensure is that no schedule or push trigger is
// added, and that we don't count as "manual" because that leads to the
// creation of a working copy task we don't need.
return new ReleaseTrigger({
workflowDispatchOnly: true,
});
}
/**
* Creates a continuous release trigger.
*
* Automated releases will occur on every commit.
*/
static continuous(options = {}) {
return new ReleaseTrigger({
continuous: true,
paths: options.paths,
});
}
constructor(options = {}) {
this.isContinuous = options.continuous ?? false;
this.paths = options.paths;
this.schedule = options.schedule;
this.changelogPath = options.changelogPath;
this.gitPushCommand = options.gitPushCommand;
this.workflowDispatchOnly = options.workflowDispatchOnly;
}
/**
* Whether or not this is a release trigger with a manual task run in a working copy.
*
* If the `ReleaseTrigger` is a GitHub-only manual task, this will return `false`.
*/
get isManual() {
return !(this.isContinuous || this.schedule) && !this.workflowDispatchOnly;
}
}
exports.ReleaseTrigger = ReleaseTrigger;
_a = JSII_RTTI_SYMBOL_1;
ReleaseTrigger[_a] = { fqn: "projen.release.ReleaseTrigger", version: "0.95.2" };
//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"release-trigger.js","sourceRoot":"","sources":["../../src/release/release-trigger.ts"],"names":[],"mappings":";;;;;AAqFA;;;GAGG;AACH,MAAa,cAAc;IACzB;;;;;;;;;;;;;;;;OAgBG;IACI,MAAM,CAAC,MAAM,CAAC,UAAgC,EAAE;QACrD,IAAI,aAAa,CAAC;QAElB,IAAI,OAAO,CAAC,SAAS,IAAI,IAAI,EAAE,CAAC;YAC9B,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,cAAc,CAAC;QAC1D,CAAC;QAED,OAAO,IAAI,cAAc,CAAC;YACxB,aAAa,EAAE,aAAa;YAC5B,cAAc,EAAE,OAAO,CAAC,cAAc;SACvC,CAAC,CAAC;IACL,CAAC;IAED;;;;;;OAMG;IACI,MAAM,CAAC,SAAS,CAAC,OAAgC;QACtD,OAAO,IAAI,cAAc,CAAC;YACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,gBAAgB;QAC5B,mFAAmF;QACnF,EAAE;QACF,0EAA0E;QAC1E,uEAAuE;QACvE,iDAAiD;QACjD,OAAO,IAAI,cAAc,CAAC;YACxB,oBAAoB,EAAE,IAAI;SAC3B,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,UAAU,CAAC,UAAoC,EAAE;QAC7D,OAAO,IAAI,cAAc,CAAC;YACxB,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE,OAAO,CAAC,KAAK;SACrB,CAAC,CAAC;IACL,CAAC;IAmCD,YAAoB,UAAiC,EAAE;QACrD,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC,UAAU,IAAI,KAAK,CAAC;QAChD,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC,KAAK,CAAC;QAC3B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;QACjC,IAAI,CAAC,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;QAC3C,IAAI,CAAC,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;QAC7C,IAAI,CAAC,oBAAoB,GAAG,OAAO,CAAC,oBAAoB,CAAC;IAC3D,CAAC;IAED;;;;OAIG;IACH,IAAW,QAAQ;QACjB,OAAO,CAAC,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,oBAAoB,CAAC;IAC7E,CAAC;;AAvHH,wCAwHC","sourcesContent":["export interface ScheduledReleaseOptions {\n  /**\n   * Cron schedule for releases.\n   *\n   * Only defined if this is a scheduled release.\n   *\n   * @example '0 17 * * *' - every day at 5 pm\n   */\n  readonly schedule: string;\n}\n\nexport interface ManualReleaseOptions {\n  /**\n   * Maintain a project-level changelog.\n   *\n   * @default true\n   */\n  readonly changelog?: boolean;\n\n  /**\n   * Project-level changelog file path.\n   *\n   * Ignored if `changelog` is false.\n   *\n   * @default 'CHANGELOG.md'\n   */\n  readonly changelogPath?: string;\n\n  /**\n   * Override git-push command.\n   *\n   * Set to an empty string to disable pushing.\n   */\n  readonly gitPushCommand?: string;\n}\n\nexport interface ContinuousReleaseOptions {\n  /**\n   * Paths for which pushes should trigger a release\n   */\n  readonly paths?: string[];\n}\n\ninterface ReleaseTriggerOptions {\n  /**\n   * Project-level changelog file path.\n   *\n   * Ignored if `changelog` is false\n   */\n  readonly changelogPath?: string;\n\n  /**\n   * Continuous releases, which will release every commit.\n   *\n   * @default false\n   */\n  readonly continuous?: boolean;\n\n  /**\n   * Paths for which pushes (continuous release) should trigger a release\n   */\n  readonly paths?: string[];\n\n  /**\n   * Cron schedule for release.\n   *\n   * Only defined if this is a scheduled release.\n   *\n   * @example '0 17 * * *' - every day at 5 pm\n   */\n  readonly schedule?: string;\n\n  /**\n   * Override git-push command.\n   *\n   * Set to an empty string to disable pushing.\n   */\n  readonly gitPushCommand?: string;\n\n  /**\n   * Only a workflowDispatch trigger\n   */\n  readonly workflowDispatchOnly?: boolean;\n}\n\n/**\n * Used to manage release strategies. This includes release\n * and release artifact automation\n */\nexport class ReleaseTrigger {\n  /**\n   * Creates a manual release trigger.\n   *\n   * Use this option if you want totally manual releases.\n   *\n   * This will give you a release task that, in addition to the normal\n   * release activities will trigger a `publish:git` task. This task will\n   * handle project-level changelog management, release tagging, and pushing\n   * these artifacts to origin.\n   *\n   * The command used for pushing can be customised by specifying\n   * `gitPushCommand`. Set to an empty string to disable pushing entirely.\n   *\n   * Simply run `yarn release` to trigger a manual release.\n   *\n   * @param options release options\n   */\n  public static manual(options: ManualReleaseOptions = {}) {\n    let changelogPath;\n\n    if (options.changelog ?? true) {\n      changelogPath = options.changelogPath ?? \"CHANGELOG.md\";\n    }\n\n    return new ReleaseTrigger({\n      changelogPath: changelogPath,\n      gitPushCommand: options.gitPushCommand,\n    });\n  }\n\n  /**\n   * Creates a scheduled release trigger.\n   *\n   * Automated releases will occur based on the provided cron schedule.\n   *\n   * @param options release options.\n   */\n  public static scheduled(options: ScheduledReleaseOptions) {\n    return new ReleaseTrigger({\n      schedule: options.schedule,\n    });\n  }\n\n  /**\n   * The release can only be triggered using the GitHub UI.\n   */\n  public static workflowDispatch() {\n    // This works because every workflow is always automatically `workflowDispatch`able\n    //\n    // The only thing we need to ensure is that no schedule or push trigger is\n    // added, and that we don't count as \"manual\" because that leads to the\n    // creation of a working copy task we don't need.\n    return new ReleaseTrigger({\n      workflowDispatchOnly: true,\n    });\n  }\n\n  /**\n   * Creates a continuous release trigger.\n   *\n   * Automated releases will occur on every commit.\n   */\n  public static continuous(options: ContinuousReleaseOptions = {}) {\n    return new ReleaseTrigger({\n      continuous: true,\n      paths: options.paths,\n    });\n  }\n\n  /**\n   * Project-level changelog file path.\n   */\n  public readonly changelogPath?: string;\n\n  /**\n   * Cron schedule for releases.\n   *\n   * Only defined if this is a scheduled release.\n   *\n   * @example '0 17 * * *' - every day at 5 pm\n   */\n  public readonly schedule?: string;\n\n  /**\n   * Whether or not this is a continuous release.\n   */\n  public readonly isContinuous: boolean;\n\n  /**\n   * Paths for which pushes will trigger a release when `isContinuous` is `true`\n   */\n  public readonly paths?: string[];\n\n  /**\n   * Override git-push command used when releasing manually.\n   *\n   * Set to an empty string to disable pushing.\n   */\n  public readonly gitPushCommand?: string;\n\n  private readonly workflowDispatchOnly?: boolean;\n\n  private constructor(options: ReleaseTriggerOptions = {}) {\n    this.isContinuous = options.continuous ?? false;\n    this.paths = options.paths;\n    this.schedule = options.schedule;\n    this.changelogPath = options.changelogPath;\n    this.gitPushCommand = options.gitPushCommand;\n    this.workflowDispatchOnly = options.workflowDispatchOnly;\n  }\n\n  /**\n   * Whether or not this is a release trigger with a manual task run in a working copy.\n   *\n   * If the `ReleaseTrigger` is a GitHub-only manual task, this will return `false`.\n   */\n  public get isManual() {\n    return !(this.isContinuous || this.schedule) && !this.workflowDispatchOnly;\n  }\n}\n"]}