projen 0.52.21 → 0.52.25
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +139 -107
- package/changelog.md +3 -3
- package/docs/api/API.md +42 -39
- package/lib/awscdk/auto-discover.d.ts +14 -46
- package/lib/awscdk/auto-discover.js +8 -22
- package/lib/awscdk/awscdk-app-java.d.ts +10 -32
- package/lib/awscdk/awscdk-app-java.js +5 -9
- package/lib/awscdk/awscdk-app-ts.d.ts +15 -35
- package/lib/awscdk/awscdk-app-ts.js +6 -14
- package/lib/awscdk/awscdk-construct.d.ts +14 -28
- package/lib/awscdk/awscdk-construct.js +8 -16
- package/lib/awscdk/awscdk-deps-java.d.ts +1 -8
- package/lib/awscdk/awscdk-deps-java.js +3 -10
- package/lib/awscdk/awscdk-deps-js.d.ts +1 -8
- package/lib/awscdk/awscdk-deps-js.js +3 -10
- package/lib/awscdk/awscdk-deps.d.ts +28 -67
- package/lib/awscdk/awscdk-deps.js +5 -12
- package/lib/awscdk/cdk-config.d.ts +19 -51
- package/lib/awscdk/cdk-config.js +13 -11
- package/lib/awscdk/cdk-tasks.d.ts +7 -24
- package/lib/awscdk/cdk-tasks.js +3 -8
- package/lib/awscdk/integration-test.d.ts +7 -29
- package/lib/awscdk/integration-test.js +3 -8
- package/lib/awscdk/lambda-function.d.ts +22 -50
- package/lib/awscdk/lambda-function.js +11 -24
- package/lib/build/build-workflow.d.ts +33 -78
- package/lib/build/build-workflow.js +15 -25
- package/lib/cdk/auto-discover-base.d.ts +11 -34
- package/lib/cdk/auto-discover-base.js +5 -15
- package/lib/cdk/construct-lib.d.ts +8 -22
- package/lib/cdk/construct-lib.js +3 -8
- package/lib/cdk/integration-test-base.d.ts +12 -38
- package/lib/cdk/integration-test-base.js +2 -8
- package/lib/cdk/jsii-docgen.d.ts +6 -12
- package/lib/cdk/jsii-docgen.js +6 -8
- package/lib/cdk/jsii-project.d.ts +16 -95
- package/lib/cdk/jsii-project.js +3 -10
- package/lib/cdk8s/auto-discover.d.ts +6 -23
- package/lib/cdk8s/auto-discover.js +6 -15
- package/lib/cdk8s/cdk8s-app-ts.d.ts +21 -43
- package/lib/cdk8s/cdk8s-app-ts.js +4 -7
- package/lib/cdk8s/cdk8s-construct.d.ts +12 -27
- package/lib/cdk8s/cdk8s-construct.js +3 -7
- package/lib/cdk8s/integration-test.d.ts +2 -9
- package/lib/cdk8s/integration-test.js +3 -8
- package/lib/cdktf/cdktf-construct.d.ts +3 -12
- package/lib/cdktf/cdktf-construct.js +3 -7
- package/lib/component.d.ts +4 -17
- package/lib/component.js +6 -19
- package/lib/dependencies.d.ts +44 -77
- package/lib/dependencies.js +50 -38
- package/lib/dev-env.d.ts +26 -53
- package/lib/dev-env.js +9 -19
- package/lib/docker-compose.d.ts +83 -209
- package/lib/docker-compose.js +38 -61
- package/lib/file.d.ts +24 -71
- package/lib/file.js +4 -16
- package/lib/gitattributes.d.ts +3 -14
- package/lib/gitattributes.js +5 -16
- package/lib/github/auto-approve.d.ts +7 -23
- package/lib/github/auto-approve.js +3 -8
- package/lib/github/auto-merge.d.ts +7 -29
- package/lib/github/auto-merge.js +7 -16
- package/lib/github/dependabot.d.ts +54 -147
- package/lib/github/dependabot.js +81 -22
- package/lib/github/github-project.d.ts +26 -70
- package/lib/github/github-project.js +5 -10
- package/lib/github/github.d.ts +19 -58
- package/lib/github/github.js +9 -30
- package/lib/github/mergify.d.ts +9 -54
- package/lib/github/mergify.js +2 -14
- package/lib/github/pr-template.d.ts +3 -13
- package/lib/github/pr-template.js +3 -8
- package/lib/github/pull-request-lint.d.ts +8 -28
- package/lib/github/pull-request-lint.js +3 -9
- package/lib/github/stale.d.ts +17 -47
- package/lib/github/stale.js +6 -10
- package/lib/github/task-workflow.d.ts +21 -63
- package/lib/github/task-workflow.js +3 -8
- package/lib/github/workflows-model.d.ts +199 -582
- package/lib/github/workflows-model.js +5 -4
- package/lib/github/workflows.d.ts +14 -41
- package/lib/github/workflows.js +8 -16
- package/lib/gitlab/configuration-model.d.ts +145 -947
- package/lib/gitlab/configuration-model.js +11 -28
- package/lib/gitlab/configuration.d.ts +31 -121
- package/lib/gitlab/configuration.js +14 -49
- package/lib/gitlab/gitlab-configuration.d.ts +2 -13
- package/lib/gitlab/gitlab-configuration.js +4 -15
- package/lib/gitlab/nested-configuration.d.ts +1 -9
- package/lib/gitlab/nested-configuration.js +3 -8
- package/lib/gitpod.d.ts +71 -167
- package/lib/gitpod.js +75 -42
- package/lib/ignore-file.d.ts +4 -23
- package/lib/ignore-file.js +6 -25
- package/lib/ini.d.ts +2 -14
- package/lib/ini.js +3 -13
- package/lib/java/java-project.d.ts +29 -70
- package/lib/java/java-project.js +10 -17
- package/lib/java/junit.d.ts +5 -17
- package/lib/java/junit.js +3 -8
- package/lib/java/maven-compile.d.ts +4 -13
- package/lib/java/maven-compile.js +3 -8
- package/lib/java/maven-packaging.d.ts +6 -21
- package/lib/java/maven-packaging.js +3 -8
- package/lib/java/maven-sample.d.ts +2 -12
- package/lib/java/maven-sample.js +3 -8
- package/lib/java/pom.d.ts +38 -100
- package/lib/java/pom.js +13 -25
- package/lib/java/projenrc.d.ts +7 -22
- package/lib/java/projenrc.js +3 -8
- package/lib/javascript/bundler.d.ts +30 -72
- package/lib/javascript/bundler.js +13 -21
- package/lib/javascript/eslint.d.ts +27 -84
- package/lib/javascript/eslint.js +11 -30
- package/lib/javascript/jest.d.ts +91 -344
- package/lib/javascript/jest.js +6 -23
- package/lib/javascript/node-package.d.ts +111 -259
- package/lib/javascript/node-package.js +64 -81
- package/lib/javascript/node-project.d.ts +112 -220
- package/lib/javascript/node-project.js +54 -73
- package/lib/javascript/npm-config.d.ts +9 -19
- package/lib/javascript/npm-config.js +9 -16
- package/lib/javascript/prettier.d.ts +65 -196
- package/lib/javascript/prettier.js +70 -46
- package/lib/javascript/projenrc.d.ts +2 -12
- package/lib/javascript/projenrc.js +3 -8
- package/lib/javascript/typescript-config.d.ts +62 -158
- package/lib/javascript/typescript-config.js +31 -18
- package/lib/javascript/upgrade-dependencies.d.ts +35 -94
- package/lib/javascript/upgrade-dependencies.js +21 -51
- package/lib/json.d.ts +3 -17
- package/lib/json.js +3 -13
- package/lib/license.d.ts +3 -20
- package/lib/license.js +2 -13
- package/lib/logger.d.ts +18 -62
- package/lib/logger.js +17 -37
- package/lib/makefile.d.ts +14 -45
- package/lib/makefile.js +7 -25
- package/lib/object-file.d.ts +19 -39
- package/lib/object-file.js +17 -28
- package/lib/option-hints.d.ts +4 -13
- package/lib/option-hints.js +11 -5
- package/lib/project-build.d.ts +7 -26
- package/lib/project-build.js +3 -8
- package/lib/project.d.ts +64 -186
- package/lib/project.js +43 -91
- package/lib/projects.d.ts +11 -32
- package/lib/projects.js +4 -8
- package/lib/projenrc-json.d.ts +2 -12
- package/lib/projenrc-json.js +3 -8
- package/lib/python/pip.d.ts +7 -23
- package/lib/python/pip.js +8 -17
- package/lib/python/poetry.d.ts +36 -121
- package/lib/python/poetry.js +12 -26
- package/lib/python/projenrc.d.ts +4 -15
- package/lib/python/projenrc.js +3 -8
- package/lib/python/pytest.d.ts +3 -16
- package/lib/python/pytest.js +2 -8
- package/lib/python/python-deps.d.ts +7 -21
- package/lib/python/python-deps.js +1 -1
- package/lib/python/python-env.d.ts +1 -6
- package/lib/python/python-env.js +1 -1
- package/lib/python/python-packaging.d.ts +12 -34
- package/lib/python/python-packaging.js +1 -1
- package/lib/python/python-project.d.ts +34 -79
- package/lib/python/python-project.js +7 -20
- package/lib/python/python-sample.d.ts +2 -9
- package/lib/python/python-sample.js +3 -8
- package/lib/python/requirements-file.d.ts +4 -19
- package/lib/python/requirements-file.js +5 -15
- package/lib/python/setuppy.d.ts +11 -39
- package/lib/python/setuppy.js +3 -13
- package/lib/python/setuptools.d.ts +2 -14
- package/lib/python/setuptools.js +3 -8
- package/lib/python/venv.d.ts +4 -14
- package/lib/python/venv.js +4 -11
- package/lib/readme.d.ts +7 -16
- package/lib/readme.js +5 -7
- package/lib/release/publisher.d.ts +103 -206
- package/lib/release/publisher.js +47 -59
- package/lib/release/release-trigger.d.ts +16 -48
- package/lib/release/release-trigger.js +8 -18
- package/lib/release/release.d.ts +50 -110
- package/lib/release/release.js +9 -24
- package/lib/run-task.js +1820 -0
- package/lib/sample-file.d.ts +14 -47
- package/lib/sample-file.js +9 -30
- package/lib/semver.d.ts +4 -21
- package/lib/semver.js +6 -20
- package/lib/source-code.d.ts +7 -23
- package/lib/source-code.js +7 -19
- package/lib/task-model.d.ts +21 -61
- package/lib/task-model.js +1 -1
- package/lib/task-runtime.d.ts +7 -24
- package/lib/task-runtime.js +7 -20
- package/lib/task.d.ts +29 -73
- package/lib/task.js +28 -61
- package/lib/tasks.d.ts +12 -34
- package/lib/tasks.js +14 -36
- package/lib/testing.d.ts +6 -10
- package/lib/testing.js +8 -12
- package/lib/textfile.d.ts +9 -24
- package/lib/textfile.js +9 -19
- package/lib/toml.d.ts +2 -14
- package/lib/toml.js +3 -13
- package/lib/typescript/projenrc.d.ts +4 -14
- package/lib/typescript/projenrc.js +3 -8
- package/lib/typescript/typescript-typedoc.d.ts +1 -6
- package/lib/typescript/typescript-typedoc.js +3 -8
- package/lib/typescript/typescript.d.ts +24 -82
- package/lib/typescript/typescript.js +6 -15
- package/lib/version.d.ts +9 -38
- package/lib/version.js +2 -11
- package/lib/vscode/devcontainer.d.ts +10 -30
- package/lib/vscode/devcontainer.js +10 -26
- package/lib/vscode/launch-config.d.ts +18 -97
- package/lib/vscode/launch-config.js +9 -15
- package/lib/vscode/vscode.d.ts +0 -9
- package/lib/vscode/vscode.js +2 -11
- package/lib/web/next.d.ts +19 -60
- package/lib/web/next.js +6 -20
- package/lib/web/postcss.d.ts +3 -24
- package/lib/web/postcss.js +3 -8
- package/lib/web/react.d.ts +13 -60
- package/lib/web/react.js +7 -32
- package/lib/web/tailwind.d.ts +1 -15
- package/lib/web/tailwind.js +3 -7
- package/lib/xmlfile.d.ts +2 -14
- package/lib/xmlfile.js +3 -13
- package/lib/yaml.d.ts +4 -19
- package/lib/yaml.js +3 -13
- package/package.json +5 -5
- package/releasetag.txt +1 -1
- package/version.txt +1 -1
|
@@ -4,12 +4,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
|
|
|
4
4
|
exports.ReleaseTrigger = void 0;
|
|
5
5
|
const JSII_RTTI_SYMBOL_1 = Symbol.for("jsii.rtti");
|
|
6
6
|
/**
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* This includes release
|
|
7
|
+
* Used to manage release strategies. This includes release
|
|
10
8
|
* and release artifact automation
|
|
11
|
-
*
|
|
12
|
-
* @experimental
|
|
13
9
|
*/
|
|
14
10
|
class ReleaseTrigger {
|
|
15
11
|
constructor(options = {}) {
|
|
@@ -20,7 +16,7 @@ class ReleaseTrigger {
|
|
|
20
16
|
this.gitPushCommand = options.gitPushCommand;
|
|
21
17
|
}
|
|
22
18
|
/**
|
|
23
|
-
*
|
|
19
|
+
* Creates a manual release trigger.
|
|
24
20
|
*
|
|
25
21
|
* Use this option if you want totally manual releases.
|
|
26
22
|
*
|
|
@@ -34,8 +30,7 @@ class ReleaseTrigger {
|
|
|
34
30
|
*
|
|
35
31
|
* Simply run `yarn release` to trigger a manual release.
|
|
36
32
|
*
|
|
37
|
-
* @param options release options
|
|
38
|
-
* @experimental
|
|
33
|
+
* @param options release options
|
|
39
34
|
*/
|
|
40
35
|
static manual(options = {}) {
|
|
41
36
|
var _b, _c;
|
|
@@ -49,12 +44,11 @@ class ReleaseTrigger {
|
|
|
49
44
|
});
|
|
50
45
|
}
|
|
51
46
|
/**
|
|
52
|
-
*
|
|
47
|
+
* Creates a scheduled release trigger.
|
|
53
48
|
*
|
|
54
49
|
* Automated releases will occur based on the provided cron schedule.
|
|
55
50
|
*
|
|
56
51
|
* @param options release options.
|
|
57
|
-
* @experimental
|
|
58
52
|
*/
|
|
59
53
|
static scheduled(options) {
|
|
60
54
|
return new ReleaseTrigger({
|
|
@@ -62,11 +56,9 @@ class ReleaseTrigger {
|
|
|
62
56
|
});
|
|
63
57
|
}
|
|
64
58
|
/**
|
|
65
|
-
*
|
|
59
|
+
* Creates a continuous release trigger.
|
|
66
60
|
*
|
|
67
61
|
* Automated releases will occur on every commit.
|
|
68
|
-
*
|
|
69
|
-
* @experimental
|
|
70
62
|
*/
|
|
71
63
|
static continuous() {
|
|
72
64
|
return new ReleaseTrigger({
|
|
@@ -74,9 +66,7 @@ class ReleaseTrigger {
|
|
|
74
66
|
});
|
|
75
67
|
}
|
|
76
68
|
/**
|
|
77
|
-
*
|
|
78
|
-
*
|
|
79
|
-
* @experimental
|
|
69
|
+
* Whether or not this is a manual release trigger.
|
|
80
70
|
*/
|
|
81
71
|
get isManual() {
|
|
82
72
|
return !(this.isContinuous || this.schedule);
|
|
@@ -84,5 +74,5 @@ class ReleaseTrigger {
|
|
|
84
74
|
}
|
|
85
75
|
exports.ReleaseTrigger = ReleaseTrigger;
|
|
86
76
|
_a = JSII_RTTI_SYMBOL_1;
|
|
87
|
-
ReleaseTrigger[_a] = { fqn: "projen.release.ReleaseTrigger", version: "0.52.
|
|
88
|
-
//# sourceMappingURL=data:application/json;base64,
|
|
77
|
+
ReleaseTrigger[_a] = { fqn: "projen.release.ReleaseTrigger", version: "0.52.25" };
|
|
78
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicmVsZWFzZS10cmlnZ2VyLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3JlbGVhc2UvcmVsZWFzZS10cmlnZ2VyLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7O0FBb0VBOzs7R0FHRztBQUNILE1BQWEsY0FBYztJQWlGekIsWUFBb0IsVUFBaUMsRUFBRTs7UUFDckQsSUFBSSxDQUFDLFlBQVksU0FBRyxPQUFPLENBQUMsVUFBVSxtQ0FBSSxLQUFLLENBQUM7UUFDaEQsSUFBSSxDQUFDLFFBQVEsR0FBRyxPQUFPLENBQUMsUUFBUSxDQUFDO1FBQ2pDLElBQUksQ0FBQyxhQUFhLEdBQUcsT0FBTyxDQUFDLGFBQWEsQ0FBQztRQUMzQyxJQUFJLENBQUMsY0FBYyxHQUFHLE9BQU8sQ0FBQyxjQUFjLENBQUM7SUFDL0MsQ0FBQztJQXJGRDs7Ozs7Ozs7Ozs7Ozs7OztPQWdCRztJQUNJLE1BQU0sQ0FBQyxNQUFNLENBQUMsVUFBZ0MsRUFBRTs7UUFDckQsSUFBSSxhQUFhLENBQUM7UUFFbEIsVUFBSSxPQUFPLENBQUMsU0FBUyxtQ0FBSSxJQUFJLEVBQUU7WUFDN0IsYUFBYSxTQUFHLE9BQU8sQ0FBQyxhQUFhLG1DQUFJLGNBQWMsQ0FBQztTQUN6RDtRQUVELE9BQU8sSUFBSSxjQUFjLENBQUM7WUFDeEIsYUFBYSxFQUFFLGFBQWE7WUFDNUIsY0FBYyxFQUFFLE9BQU8sQ0FBQyxjQUFjO1NBQ3ZDLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRDs7Ozs7O09BTUc7SUFDSSxNQUFNLENBQUMsU0FBUyxDQUFDLE9BQWdDO1FBQ3RELE9BQU8sSUFBSSxjQUFjLENBQUM7WUFDeEIsUUFBUSxFQUFFLE9BQU8sQ0FBQyxRQUFRO1NBQzNCLENBQUMsQ0FBQztJQUNMLENBQUM7SUFFRDs7OztPQUlHO0lBQ0ksTUFBTSxDQUFDLFVBQVU7UUFDdEIsT0FBTyxJQUFJLGNBQWMsQ0FBQztZQUN4QixVQUFVLEVBQUUsSUFBSTtTQUNqQixDQUFDLENBQUM7SUFDTCxDQUFDO0lBbUNEOztPQUVHO0lBQ0gsSUFBVyxRQUFRO1FBQ2pCLE9BQU8sQ0FBQyxDQUFDLElBQUksQ0FBQyxZQUFZLElBQUksSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDO0lBQy9DLENBQUM7O0FBN0ZILHdDQThGQyIsInNvdXJjZXNDb250ZW50IjpbImV4cG9ydCBpbnRlcmZhY2UgU2NoZWR1bGVkUmVsZWFzZU9wdGlvbnMge1xuICAvKipcbiAgICogQ3JvbiBzY2hlZHVsZSBmb3IgcmVsZWFzZXMuXG4gICAqXG4gICAqIE9ubHkgZGVmaW5lZCBpZiB0aGlzIGlzIGEgc2NoZWR1bGVkIHJlbGVhc2UuXG4gICAqXG4gICAqIEBleGFtcGxlICcwIDE3ICogKiAqJyAtIGV2ZXJ5IGRheSBhdCA1IHBtXG4gICAqL1xuICByZWFkb25seSBzY2hlZHVsZTogc3RyaW5nO1xufVxuXG5leHBvcnQgaW50ZXJmYWNlIE1hbnVhbFJlbGVhc2VPcHRpb25zIHtcbiAgLyoqXG4gICAqIE1haW50YWluIGEgcHJvamVjdC1sZXZlbCBjaGFuZ2Vsb2cuXG4gICAqXG4gICAqIEBkZWZhdWx0IHRydWVcbiAgICovXG4gIHJlYWRvbmx5IGNoYW5nZWxvZz86IGJvb2xlYW47XG5cbiAgLyoqXG4gICAqIFByb2plY3QtbGV2ZWwgY2hhbmdlbG9nIGZpbGUgcGF0aC5cbiAgICpcbiAgICogSWdub3JlZCBpZiBgY2hhbmdlbG9nYCBpcyBmYWxzZS5cbiAgICpcbiAgICogQGRlZmF1bHQgJ0NIQU5HRUxPRy5tZCdcbiAgICovXG4gIHJlYWRvbmx5IGNoYW5nZWxvZ1BhdGg/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIE92ZXJyaWRlIGdpdC1wdXNoIGNvbW1hbmQuXG4gICAqXG4gICAqIFNldCB0byBhbiBlbXB0eSBzdHJpbmcgdG8gZGlzYWJsZSBwdXNoaW5nLlxuICAgKi9cbiAgcmVhZG9ubHkgZ2l0UHVzaENvbW1hbmQ/OiBzdHJpbmc7XG59XG5cbmludGVyZmFjZSBSZWxlYXNlVHJpZ2dlck9wdGlvbnMge1xuICAvKipcbiAgICogUHJvamVjdC1sZXZlbCBjaGFuZ2Vsb2cgZmlsZSBwYXRoLlxuICAgKlxuICAgKiBJZ25vcmVkIGlmIGBjaGFuZ2Vsb2dgIGlzIGZhbHNlXG4gICAqL1xuICByZWFkb25seSBjaGFuZ2Vsb2dQYXRoPzogc3RyaW5nO1xuXG4gIC8qKlxuICAgKiBDb250aW51b3VzIHJlbGVhc2VzLCB3aGljaCB3aWxsIHJlbGVhc2UgZXZlcnkgY29tbWl0LlxuICAgKlxuICAgKiBAZGVmYXVsdCBmYWxzZVxuICAgKi9cbiAgcmVhZG9ubHkgY29udGludW91cz86IGJvb2xlYW47XG5cbiAgLyoqXG4gICAqIENyb24gc2NoZWR1bGUgZm9yIHJlbGVhc2UuXG4gICAqXG4gICAqIE9ubHkgZGVmaW5lZCBpZiB0aGlzIGlzIGEgc2NoZWR1bGVkIHJlbGVhc2UuXG4gICAqXG4gICAqIEBleGFtcGxlICcwIDE3ICogKiAqJyAtIGV2ZXJ5IGRheSBhdCA1IHBtXG4gICAqL1xuICByZWFkb25seSBzY2hlZHVsZT86IHN0cmluZztcblxuICAvKipcbiAgICogT3ZlcnJpZGUgZ2l0LXB1c2ggY29tbWFuZC5cbiAgICpcbiAgICogU2V0IHRvIGFuIGVtcHR5IHN0cmluZyB0byBkaXNhYmxlIHB1c2hpbmcuXG4gICAqL1xuICByZWFkb25seSBnaXRQdXNoQ29tbWFuZD86IHN0cmluZztcbn1cblxuLyoqXG4gKiBVc2VkIHRvIG1hbmFnZSByZWxlYXNlIHN0cmF0ZWdpZXMuIFRoaXMgaW5jbHVkZXMgcmVsZWFzZVxuICogYW5kIHJlbGVhc2UgYXJ0aWZhY3QgYXV0b21hdGlvblxuICovXG5leHBvcnQgY2xhc3MgUmVsZWFzZVRyaWdnZXIge1xuICAvKipcbiAgICogQ3JlYXRlcyBhIG1hbnVhbCByZWxlYXNlIHRyaWdnZXIuXG4gICAqXG4gICAqIFVzZSB0aGlzIG9wdGlvbiBpZiB5b3Ugd2FudCB0b3RhbGx5IG1hbnVhbCByZWxlYXNlcy5cbiAgICpcbiAgICogVGhpcyB3aWxsIGdpdmUgeW91IGEgcmVsZWFzZSB0YXNrIHRoYXQsIGluIGFkZGl0aW9uIHRvIHRoZSBub3JtYWxcbiAgICogcmVsZWFzZSBhY3Rpdml0aWVzIHdpbGwgdHJpZ2dlciBhIGBwdWJsaXNoOmdpdGAgdGFzay4gVGhpcyB0YXNrIHdpbGxcbiAgICogaGFuZGxlIHByb2plY3QtbGV2ZWwgY2hhbmdlbG9nIG1hbmFnZW1lbnQsIHJlbGVhc2UgdGFnZ2luZywgYW5kIHB1c2hpbmdcbiAgICogdGhlc2UgYXJ0aWZhY3RzIHRvIG9yaWdpbi5cbiAgICpcbiAgICogVGhlIGNvbW1hbmQgdXNlZCBmb3IgcHVzaGluZyBjYW4gYmUgY3VzdG9taXNlZCBieSBzcGVjaWZ5aW5nXG4gICAqIGBnaXRQdXNoQ29tbWFuZGAuIFNldCB0byBhbiBlbXB0eSBzdHJpbmcgdG8gZGlzYWJsZSBwdXNoaW5nIGVudGlyZWx5LlxuICAgKlxuICAgKiBTaW1wbHkgcnVuIGB5YXJuIHJlbGVhc2VgIHRvIHRyaWdnZXIgYSBtYW51YWwgcmVsZWFzZS5cbiAgICpcbiAgICogQHBhcmFtIG9wdGlvbnMgcmVsZWFzZSBvcHRpb25zXG4gICAqL1xuICBwdWJsaWMgc3RhdGljIG1hbnVhbChvcHRpb25zOiBNYW51YWxSZWxlYXNlT3B0aW9ucyA9IHt9KSB7XG4gICAgbGV0IGNoYW5nZWxvZ1BhdGg7XG5cbiAgICBpZiAob3B0aW9ucy5jaGFuZ2Vsb2cgPz8gdHJ1ZSkge1xuICAgICAgY2hhbmdlbG9nUGF0aCA9IG9wdGlvbnMuY2hhbmdlbG9nUGF0aCA/PyBcIkNIQU5HRUxPRy5tZFwiO1xuICAgIH1cblxuICAgIHJldHVybiBuZXcgUmVsZWFzZVRyaWdnZXIoe1xuICAgICAgY2hhbmdlbG9nUGF0aDogY2hhbmdlbG9nUGF0aCxcbiAgICAgIGdpdFB1c2hDb21tYW5kOiBvcHRpb25zLmdpdFB1c2hDb21tYW5kLFxuICAgIH0pO1xuICB9XG5cbiAgLyoqXG4gICAqIENyZWF0ZXMgYSBzY2hlZHVsZWQgcmVsZWFzZSB0cmlnZ2VyLlxuICAgKlxuICAgKiBBdXRvbWF0ZWQgcmVsZWFzZXMgd2lsbCBvY2N1ciBiYXNlZCBvbiB0aGUgcHJvdmlkZWQgY3JvbiBzY2hlZHVsZS5cbiAgICpcbiAgICogQHBhcmFtIG9wdGlvbnMgcmVsZWFzZSBvcHRpb25zLlxuICAgKi9cbiAgcHVibGljIHN0YXRpYyBzY2hlZHVsZWQob3B0aW9uczogU2NoZWR1bGVkUmVsZWFzZU9wdGlvbnMpIHtcbiAgICByZXR1cm4gbmV3IFJlbGVhc2VUcmlnZ2VyKHtcbiAgICAgIHNjaGVkdWxlOiBvcHRpb25zLnNjaGVkdWxlLFxuICAgIH0pO1xuICB9XG5cbiAgLyoqXG4gICAqIENyZWF0ZXMgYSBjb250aW51b3VzIHJlbGVhc2UgdHJpZ2dlci5cbiAgICpcbiAgICogQXV0b21hdGVkIHJlbGVhc2VzIHdpbGwgb2NjdXIgb24gZXZlcnkgY29tbWl0LlxuICAgKi9cbiAgcHVibGljIHN0YXRpYyBjb250aW51b3VzKCkge1xuICAgIHJldHVybiBuZXcgUmVsZWFzZVRyaWdnZXIoe1xuICAgICAgY29udGludW91czogdHJ1ZSxcbiAgICB9KTtcbiAgfVxuXG4gIC8qKlxuICAgKiBQcm9qZWN0LWxldmVsIGNoYW5nZWxvZyBmaWxlIHBhdGguXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgY2hhbmdlbG9nUGF0aD86IHN0cmluZztcblxuICAvKipcbiAgICogQ3JvbiBzY2hlZHVsZSBmb3IgcmVsZWFzZXMuXG4gICAqXG4gICAqIE9ubHkgZGVmaW5lZCBpZiB0aGlzIGlzIGEgc2NoZWR1bGVkIHJlbGVhc2UuXG4gICAqXG4gICAqIEBleGFtcGxlICcwIDE3ICogKiAqJyAtIGV2ZXJ5IGRheSBhdCA1IHBtXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgc2NoZWR1bGU/OiBzdHJpbmc7XG5cbiAgLyoqXG4gICAqIFdoZXRoZXIgb3Igbm90IHRoaXMgaXMgYSBjb250aW51b3VzIHJlbGVhc2UuXG4gICAqL1xuICBwdWJsaWMgcmVhZG9ubHkgaXNDb250aW51b3VzOiBib29sZWFuO1xuXG4gIC8qKlxuICAgKiBPdmVycmlkZSBnaXQtcHVzaCBjb21tYW5kIHVzZWQgd2hlbiByZWxlYXNpbmcgbWFudWFsbHkuXG4gICAqXG4gICAqIFNldCB0byBhbiBlbXB0eSBzdHJpbmcgdG8gZGlzYWJsZSBwdXNoaW5nLlxuICAgKi9cbiAgcHVibGljIHJlYWRvbmx5IGdpdFB1c2hDb21tYW5kPzogc3RyaW5nO1xuXG4gIHByaXZhdGUgY29uc3RydWN0b3Iob3B0aW9uczogUmVsZWFzZVRyaWdnZXJPcHRpb25zID0ge30pIHtcbiAgICB0aGlzLmlzQ29udGludW91cyA9IG9wdGlvbnMuY29udGludW91cyA/PyBmYWxzZTtcbiAgICB0aGlzLnNjaGVkdWxlID0gb3B0aW9ucy5zY2hlZHVsZTtcbiAgICB0aGlzLmNoYW5nZWxvZ1BhdGggPSBvcHRpb25zLmNoYW5nZWxvZ1BhdGg7XG4gICAgdGhpcy5naXRQdXNoQ29tbWFuZCA9IG9wdGlvbnMuZ2l0UHVzaENvbW1hbmQ7XG4gIH1cblxuICAvKipcbiAgICogV2hldGhlciBvciBub3QgdGhpcyBpcyBhIG1hbnVhbCByZWxlYXNlIHRyaWdnZXIuXG4gICAqL1xuICBwdWJsaWMgZ2V0IGlzTWFudWFsKCkge1xuICAgIHJldHVybiAhKHRoaXMuaXNDb250aW51b3VzIHx8IHRoaXMuc2NoZWR1bGUpO1xuICB9XG59XG4iXX0=
|
package/lib/release/release.d.ts
CHANGED
|
@@ -5,97 +5,85 @@ import { Task } from "../task";
|
|
|
5
5
|
import { Publisher } from "./publisher";
|
|
6
6
|
import { ReleaseTrigger } from "./release-trigger";
|
|
7
7
|
/**
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* @experimental
|
|
8
|
+
* Project options for release.
|
|
11
9
|
*/
|
|
12
10
|
export interface ReleaseProjectOptions {
|
|
13
11
|
/**
|
|
14
|
-
*
|
|
12
|
+
* Automatically release new versions every commit to one of branches in `releaseBranches`.
|
|
15
13
|
*
|
|
16
14
|
* @default true
|
|
15
|
+
*
|
|
17
16
|
* @deprecated Use `releaseTrigger: ReleaseTrigger.continuous()` instead
|
|
18
17
|
*/
|
|
19
18
|
readonly releaseEveryCommit?: boolean;
|
|
20
19
|
/**
|
|
21
|
-
*
|
|
20
|
+
* CRON schedule to trigger new releases.
|
|
22
21
|
*
|
|
23
22
|
* @default - no scheduled releases
|
|
23
|
+
*
|
|
24
24
|
* @deprecated Use `releaseTrigger: ReleaseTrigger.scheduled()` instead
|
|
25
25
|
*/
|
|
26
26
|
readonly releaseSchedule?: string;
|
|
27
27
|
/**
|
|
28
|
-
*
|
|
28
|
+
* The release trigger to use.
|
|
29
29
|
*
|
|
30
30
|
* @default - Continuous releases (`ReleaseTrigger.continuous()`)
|
|
31
|
-
* @experimental
|
|
32
31
|
*/
|
|
33
32
|
readonly releaseTrigger?: ReleaseTrigger;
|
|
34
33
|
/**
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
* @experimental
|
|
34
|
+
* A set of workflow steps to execute in order to setup the workflow
|
|
35
|
+
* container.
|
|
38
36
|
*/
|
|
39
37
|
readonly releaseWorkflowSetupSteps?: JobStep[];
|
|
40
38
|
/**
|
|
41
|
-
*
|
|
39
|
+
* Container image to use for GitHub workflows.
|
|
42
40
|
*
|
|
43
41
|
* @default - default image
|
|
44
|
-
* @experimental
|
|
45
42
|
*/
|
|
46
43
|
readonly workflowContainerImage?: string;
|
|
47
44
|
/**
|
|
48
|
-
*
|
|
49
|
-
*
|
|
45
|
+
* Version requirement of `publib` which is used to publish modules to npm.
|
|
50
46
|
* @default "latest"
|
|
51
|
-
* @experimental
|
|
52
47
|
*/
|
|
53
48
|
readonly jsiiReleaseVersion?: string;
|
|
54
49
|
/**
|
|
55
|
-
*
|
|
56
|
-
*
|
|
50
|
+
* Steps to execute after build as part of the release workflow.
|
|
57
51
|
* @default []
|
|
58
|
-
* @experimental
|
|
59
52
|
*/
|
|
60
53
|
readonly postBuildSteps?: JobStep[];
|
|
61
54
|
/**
|
|
62
|
-
*
|
|
55
|
+
* Major version to release from the default branch.
|
|
63
56
|
*
|
|
64
57
|
* If this is specified, we bump the latest version of this major version line.
|
|
65
58
|
* If not specified, we bump the global latest version.
|
|
66
59
|
*
|
|
67
60
|
* @default - Major version is not enforced.
|
|
68
|
-
* @experimental
|
|
69
61
|
*/
|
|
70
62
|
readonly majorVersion?: number;
|
|
71
63
|
/**
|
|
72
|
-
*
|
|
64
|
+
* Bump versions from the default branch as pre-releases (e.g. "beta",
|
|
65
|
+
* "alpha", "pre").
|
|
73
66
|
*
|
|
74
67
|
* @default - normal semantic versions
|
|
75
|
-
* @experimental
|
|
76
68
|
*/
|
|
77
69
|
readonly prerelease?: string;
|
|
78
70
|
/**
|
|
79
|
-
*
|
|
71
|
+
* The npmDistTag to use when publishing from the default branch.
|
|
80
72
|
*
|
|
81
73
|
* To set the npm dist-tag for release branches, set the `npmDistTag` property
|
|
82
74
|
* for each branch.
|
|
83
75
|
*
|
|
84
76
|
* @default "latest"
|
|
85
|
-
* @experimental
|
|
86
77
|
*/
|
|
87
78
|
readonly npmDistTag?: string;
|
|
88
79
|
/**
|
|
89
|
-
*
|
|
80
|
+
* The name of the default release workflow.
|
|
90
81
|
*
|
|
91
82
|
* @default "Release"
|
|
92
|
-
* @experimental
|
|
93
83
|
*/
|
|
94
84
|
readonly releaseWorkflowName?: string;
|
|
95
85
|
/**
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
* A workflow will be created for each
|
|
86
|
+
* Defines additional release branches. A workflow will be created for each
|
|
99
87
|
* release branch which will publish releases from commits in this branch.
|
|
100
88
|
* Each release branch _must_ be assigned a major version number which is used
|
|
101
89
|
* to enforce that versions published from that branch always use that major
|
|
@@ -104,29 +92,27 @@ export interface ReleaseProjectOptions {
|
|
|
104
92
|
*
|
|
105
93
|
* @default - no additional branches are used for release. you can use
|
|
106
94
|
* `addBranch()` to add additional branches.
|
|
107
|
-
* @experimental
|
|
108
95
|
*/
|
|
109
96
|
readonly releaseBranches?: {
|
|
110
97
|
[name: string]: BranchOptions;
|
|
111
98
|
};
|
|
112
99
|
/**
|
|
113
|
-
*
|
|
100
|
+
* Create a github issue on every failed publishing task.
|
|
114
101
|
*
|
|
115
102
|
* @default false
|
|
116
|
-
* @experimental
|
|
117
103
|
*/
|
|
118
104
|
readonly releaseFailureIssue?: boolean;
|
|
119
105
|
/**
|
|
120
|
-
*
|
|
121
|
-
*
|
|
106
|
+
* The label to apply to issues indicating publish failures.
|
|
122
107
|
* Only applies if `releaseFailureIssue` is true.
|
|
123
108
|
*
|
|
124
109
|
* @default "failed-release"
|
|
125
|
-
* @experimental
|
|
126
110
|
*/
|
|
127
111
|
readonly releaseFailureIssueLabel?: string;
|
|
128
112
|
/**
|
|
129
|
-
*
|
|
113
|
+
* Automatically add the given prefix to release tags.
|
|
114
|
+
* Useful if you are releasing on multiple branches with overlapping
|
|
115
|
+
* version numbers.
|
|
130
116
|
*
|
|
131
117
|
* Note: this prefix is used to detect the latest tagged version
|
|
132
118
|
* when bumping, so if you change this on a project with an existing version
|
|
@@ -134,106 +120,82 @@ export interface ReleaseProjectOptions {
|
|
|
134
120
|
* with the new prefix.
|
|
135
121
|
*
|
|
136
122
|
* @default - no prefix
|
|
137
|
-
* @experimental
|
|
138
123
|
*/
|
|
139
124
|
readonly releaseTagPrefix?: string;
|
|
140
125
|
/**
|
|
141
|
-
*
|
|
142
|
-
*
|
|
126
|
+
* Custom configuration used when creating changelog with standard-version package.
|
|
143
127
|
* Given values either append to default configuration or overwrite values in it.
|
|
144
128
|
*
|
|
145
129
|
* @default - standard configuration applicable for GitHub repositories
|
|
146
|
-
* @experimental
|
|
147
130
|
*/
|
|
148
131
|
readonly versionrcOptions?: Record<string, any>;
|
|
149
132
|
/**
|
|
150
|
-
*
|
|
151
|
-
*
|
|
133
|
+
* Github Runner selection labels
|
|
152
134
|
* @default ["ubuntu-latest"]
|
|
153
|
-
* @experimental
|
|
154
135
|
*/
|
|
155
136
|
readonly workflowRunsOn?: string[];
|
|
156
137
|
/**
|
|
157
|
-
*
|
|
138
|
+
* Define publishing tasks that can be executed manually as well as workflows.
|
|
158
139
|
*
|
|
159
140
|
* Normally, publishing only happens within automated workflows. Enable this
|
|
160
141
|
* in order to create a publishing task for each publishing activity.
|
|
161
142
|
*
|
|
162
143
|
* @default false
|
|
163
|
-
* @experimental
|
|
164
144
|
*/
|
|
165
145
|
readonly publishTasks?: boolean;
|
|
166
146
|
/**
|
|
167
|
-
*
|
|
147
|
+
* Instead of actually publishing to package managers, just print the publishing command.
|
|
168
148
|
*
|
|
169
149
|
* @default false
|
|
170
|
-
* @experimental
|
|
171
150
|
*/
|
|
172
151
|
readonly publishDryRun?: boolean;
|
|
173
152
|
}
|
|
174
153
|
/**
|
|
175
|
-
*
|
|
176
|
-
*
|
|
177
|
-
* @experimental
|
|
154
|
+
* Options for `Release`.
|
|
178
155
|
*/
|
|
179
156
|
export interface ReleaseOptions extends ReleaseProjectOptions {
|
|
180
157
|
/**
|
|
181
|
-
*
|
|
182
|
-
*
|
|
183
|
-
* Artifacts are
|
|
158
|
+
* The task to execute in order to create the release artifacts. Artifacts are
|
|
184
159
|
* expected to reside under `artifactsDirectory` (defaults to `dist/`) once
|
|
185
160
|
* build is complete.
|
|
186
|
-
*
|
|
187
|
-
* @experimental
|
|
188
161
|
*/
|
|
189
162
|
readonly task: Task;
|
|
190
163
|
/**
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
* @experimental
|
|
194
|
-
* @example
|
|
164
|
+
* A name of a .json file to set the `version` field in after a bump.
|
|
195
165
|
*
|
|
196
|
-
* "package.json"
|
|
166
|
+
* @example "package.json"
|
|
197
167
|
*/
|
|
198
168
|
readonly versionFile: string;
|
|
199
169
|
/**
|
|
200
|
-
*
|
|
170
|
+
* The default branch name to release from.
|
|
201
171
|
*
|
|
202
172
|
* Use `majorVersion` to restrict this branch to only publish releases with a
|
|
203
173
|
* specific major version.
|
|
204
174
|
*
|
|
205
175
|
* You can add additional branches using `addBranch()`.
|
|
206
|
-
*
|
|
207
|
-
* @experimental
|
|
208
176
|
*/
|
|
209
177
|
readonly branch: string;
|
|
210
178
|
/**
|
|
211
|
-
*
|
|
179
|
+
* Create a GitHub release for each release.
|
|
212
180
|
*
|
|
213
181
|
* @default true
|
|
214
|
-
* @experimental
|
|
215
182
|
*/
|
|
216
183
|
readonly githubRelease?: boolean;
|
|
217
184
|
/**
|
|
218
|
-
*
|
|
185
|
+
* A directory which will contain build artifacts.
|
|
219
186
|
*
|
|
220
187
|
* @default "dist"
|
|
221
|
-
* @experimental
|
|
222
188
|
*/
|
|
223
189
|
readonly artifactsDirectory: string;
|
|
224
190
|
}
|
|
225
191
|
/**
|
|
226
|
-
*
|
|
192
|
+
* Manages releases (currently through GitHub workflows).
|
|
227
193
|
*
|
|
228
194
|
* By default, no branches are released. To add branches, call `addBranch()`.
|
|
229
|
-
*
|
|
230
|
-
* @experimental
|
|
231
195
|
*/
|
|
232
196
|
export declare class Release extends Component {
|
|
233
197
|
/**
|
|
234
|
-
*
|
|
235
|
-
*
|
|
236
|
-
* @experimental
|
|
198
|
+
* Package publisher.
|
|
237
199
|
*/
|
|
238
200
|
readonly publisher: Publisher;
|
|
239
201
|
private readonly buildTask;
|
|
@@ -249,25 +211,19 @@ export declare class Release extends Component {
|
|
|
249
211
|
private readonly github?;
|
|
250
212
|
private readonly workflowRunsOn?;
|
|
251
213
|
/**
|
|
252
|
-
*
|
|
253
|
-
*
|
|
254
|
-
* @experimental
|
|
214
|
+
* Location of build artifacts.
|
|
255
215
|
*/
|
|
256
216
|
readonly artifactsDirectory: string;
|
|
257
|
-
/**
|
|
258
|
-
* @experimental
|
|
259
|
-
*/
|
|
260
217
|
constructor(project: GitHubProject, options: ReleaseOptions);
|
|
261
218
|
/**
|
|
262
|
-
*
|
|
219
|
+
* Adds a release branch.
|
|
263
220
|
*
|
|
264
221
|
* It is a git branch from which releases are published. If a project has more than one release
|
|
265
222
|
* branch, we require that `majorVersion` is also specified for the primary branch in order to
|
|
266
223
|
* ensure branches always release the correct version.
|
|
267
224
|
*
|
|
268
|
-
* @param branch The branch to monitor (e.g. `main`, `v2.x`)
|
|
269
|
-
* @param options Branch definition
|
|
270
|
-
* @experimental
|
|
225
|
+
* @param branch The branch to monitor (e.g. `main`, `v2.x`)
|
|
226
|
+
* @param options Branch definition
|
|
271
227
|
*/
|
|
272
228
|
addBranch(branch: string, options: BranchOptions): void;
|
|
273
229
|
/**
|
|
@@ -281,23 +237,14 @@ export declare class Release extends Component {
|
|
|
281
237
|
* @param options Branch definition
|
|
282
238
|
*/
|
|
283
239
|
private _addBranch;
|
|
284
|
-
/**
|
|
285
|
-
* (experimental) Called before synthesis.
|
|
286
|
-
*
|
|
287
|
-
* @experimental
|
|
288
|
-
*/
|
|
289
240
|
preSynthesize(): void;
|
|
290
241
|
/**
|
|
291
|
-
*
|
|
292
|
-
*
|
|
293
|
-
* @param jobs The jobs to add (name => job).
|
|
294
|
-
* @experimental
|
|
242
|
+
* Adds jobs to all release workflows.
|
|
243
|
+
* @param jobs The jobs to add (name => job)
|
|
295
244
|
*/
|
|
296
245
|
addJobs(jobs: Record<string, Job>): void;
|
|
297
246
|
/**
|
|
298
|
-
*
|
|
299
|
-
*
|
|
300
|
-
* @experimental
|
|
247
|
+
* Retrieve all release branch names
|
|
301
248
|
*/
|
|
302
249
|
get branches(): string[];
|
|
303
250
|
/**
|
|
@@ -306,33 +253,28 @@ export declare class Release extends Component {
|
|
|
306
253
|
private createWorkflow;
|
|
307
254
|
}
|
|
308
255
|
/**
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
* @experimental
|
|
256
|
+
* Options for a release branch.
|
|
312
257
|
*/
|
|
313
258
|
export interface BranchOptions {
|
|
314
259
|
/**
|
|
315
|
-
*
|
|
316
|
-
*
|
|
260
|
+
* The name of the release workflow.
|
|
317
261
|
* @default "release-BRANCH"
|
|
318
|
-
* @experimental
|
|
319
262
|
*/
|
|
320
263
|
readonly workflowName?: string;
|
|
321
264
|
/**
|
|
322
|
-
*
|
|
323
|
-
*
|
|
324
|
-
* @experimental
|
|
265
|
+
* The major versions released from this branch.
|
|
325
266
|
*/
|
|
326
267
|
readonly majorVersion: number;
|
|
327
268
|
/**
|
|
328
|
-
*
|
|
269
|
+
* Bump the version as a pre-release tag.
|
|
329
270
|
*
|
|
330
271
|
* @default - normal releases
|
|
331
|
-
* @experimental
|
|
332
272
|
*/
|
|
333
273
|
readonly prerelease?: string;
|
|
334
274
|
/**
|
|
335
|
-
*
|
|
275
|
+
* Automatically add the given prefix to release tags.
|
|
276
|
+
* Useful if you are releasing on multiple branches with overlapping
|
|
277
|
+
* version numbers.
|
|
336
278
|
*
|
|
337
279
|
* Note: this prefix is used to detect the latest tagged version
|
|
338
280
|
* when bumping, so if you change this on a project with an existing version
|
|
@@ -340,14 +282,12 @@ export interface BranchOptions {
|
|
|
340
282
|
* with the new prefix.
|
|
341
283
|
*
|
|
342
284
|
* @default - no prefix
|
|
343
|
-
* @experimental
|
|
344
285
|
*/
|
|
345
286
|
readonly tagPrefix?: string;
|
|
346
287
|
/**
|
|
347
|
-
*
|
|
288
|
+
* The npm distribution tag to use for this branch.
|
|
348
289
|
*
|
|
349
290
|
* @default "latest"
|
|
350
|
-
* @experimental
|
|
351
291
|
*/
|
|
352
292
|
readonly npmDistTag?: string;
|
|
353
293
|
}
|