projen 0.71.112 → 0.71.113

package/.jsii

@@ -7805,6 +7805,172 @@
       "name": "ProjenrcOptions",
       "symbolId": "src/projenrc-json:ProjenrcOptions"
     },
+    "projen.ReleasableCommits": {
+      "assembly": "projen",
+      "docs": {
+        "stability": "experimental",
+        "summary": "Find commits that should be considered releasable to decide if a release is required."
+      },
+      "fqn": "projen.ReleasableCommits",
+      "kind": "class",
+      "locationInModule": {
+        "filename": "src/version.ts",
+        "line": 131
+      },
+      "methods": [
+        {
+          "docs": {
+            "remarks": "This will only not release if the most recent commit is tagged with the latest matching tag.",
+            "stability": "experimental",
+            "summary": "Release every commit."
+          },
+          "locationInModule": {
+            "filename": "src/version.ts",
+            "line": 140
+          },
+          "name": "everyCommit",
+          "parameters": [
+            {
+              "docs": {
+                "remarks": "This path is relative to the current working dir of the `bump` task, i.e. to only consider commits of a subproject use `\".\"`.",
+                "summary": "Consider only commits that are enough to explain how the files that match the specified paths came to be."
+              },
+              "name": "path",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.ReleasableCommits"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "example": "\"git log --oneline $LATEST_TAG..HEAD -- .\"",
+            "remarks": "A new release will be initiated, if the number of returned commits is greater than zero.\nMust return a newline separate list of commits that should considered releasable.\n`$LATEST_TAG` will be replaced with the actual latest tag for the given prefix.*",
+            "stability": "experimental",
+            "summary": "Use an arbitrary shell command to find releasable commits since the latest tag."
+          },
+          "locationInModule": {
+            "filename": "src/version.ts",
+            "line": 185
+          },
+          "name": "exec",
+          "parameters": [
+            {
+              "name": "cmd",
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.ReleasableCommits"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "Shorthand for `ReleasableCommits.onlyOfType(['feat', 'fix'])`.",
+            "stability": "experimental",
+            "summary": "Release only features and fixes."
+          },
+          "locationInModule": {
+            "filename": "src/version.ts",
+            "line": 172
+          },
+          "name": "featuresAndFixes",
+          "parameters": [
+            {
+              "docs": {
+                "remarks": "This path is relative to the current working dir of the `bump` task, i.e. to only consider commits of a subproject use `\".\"`.",
+                "summary": "Consider only commits that are enough to explain how the files that match the specified paths came to be."
+              },
+              "name": "path",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.ReleasableCommits"
+            }
+          },
+          "static": true
+        },
+        {
+          "docs": {
+            "remarks": "This will only release commit that match one of the provided types.\nCommits are required to follow the conventional commit spec and will be ignored otherwise.",
+            "stability": "experimental",
+            "summary": "Limit commits by their conventional commit type."
+          },
+          "locationInModule": {
+            "filename": "src/version.ts",
+            "line": 155
+          },
+          "name": "ofType",
+          "parameters": [
+            {
+              "docs": {
+                "summary": "List of conventional commit types that should be released."
+              },
+              "name": "types",
+              "type": {
+                "collection": {
+                  "elementtype": {
+                    "primitive": "string"
+                  },
+                  "kind": "array"
+                }
+              }
+            },
+            {
+              "docs": {
+                "remarks": "This path is relative to the current working dir of the `bump` task, i.e. to only consider commits of a subproject use `\".\"`.",
+                "summary": "Consider only commits that are enough to explain how the files that match the specified paths came to be."
+              },
+              "name": "path",
+              "optional": true,
+              "type": {
+                "primitive": "string"
+              }
+            }
+          ],
+          "returns": {
+            "type": {
+              "fqn": "projen.ReleasableCommits"
+            }
+          },
+          "static": true
+        }
+      ],
+      "name": "ReleasableCommits",
+      "properties": [
+        {
+          "docs": {
+            "stability": "experimental"
+          },
+          "locationInModule": {
+            "filename": "src/version.ts",
+            "line": 189
+          },
+          "name": "cmd",
+          "type": {
+            "primitive": "string"
+          }
+        }
+      ],
+      "symbolId": "src/version:ReleasableCommits"
+    },
     "projen.Renovatebot": {
       "assembly": "projen",
       "base": "projen.Component",
@@ -9370,6 +9536,26 @@
       ],
       "name": "Task",
       "properties": [
+        {
+          "docs": {
+            "stability": "experimental",
+            "summary": "Returns all environment variables in the task level."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/task.ts",
+            "line": 242
+          },
+          "name": "envVars",
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "map"
+            }
+          }
+        },
         {
           "docs": {
             "stability": "experimental",
@@ -9393,7 +9579,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/task.ts",
-            "line": 242
+            "line": 248
           },
           "name": "steps",
           "type": {
@@ -10736,7 +10922,7 @@
         },
         "locationInModule": {
           "filename": "src/version.ts",
-          "line": 55
+          "line": 63
         },
         "parameters": [
           {
@@ -10756,7 +10942,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/version.ts",
-        "line": 34
+        "line": 42
       },
       "name": "Version",
       "properties": [
@@ -10768,7 +10954,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/version.ts",
-            "line": 35
+            "line": 43
           },
           "name": "STANDARD_VERSION",
           "static": true,
@@ -10783,7 +10969,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/version.ts",
-            "line": 37
+            "line": 45
           },
           "name": "bumpTask",
           "type": {
@@ -10798,7 +10984,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/version.ts",
-            "line": 43
+            "line": 51
           },
           "name": "changelogFileName",
           "type": {
@@ -10813,7 +10999,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/version.ts",
-            "line": 53
+            "line": 61
           },
           "name": "releaseTagFileName",
           "type": {
@@ -10827,7 +11013,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/version.ts",
-            "line": 38
+            "line": 46
           },
           "name": "unbumpTask",
           "type": {
@@ -10842,7 +11028,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/version.ts",
-            "line": 48
+            "line": 56
           },
           "name": "versionFileName",
           "type": {
@@ -10900,6 +11086,24 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "ReleasableCommits.everyCommit()",
+            "stability": "experimental",
+            "summary": "Find commits that should be considered releasable Used to decide if a release is required."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/version.ts",
+            "line": 39
+          },
+          "name": "releasableCommits",
+          "optional": true,
+          "type": {
+            "fqn": "projen.ReleasableCommits"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -48899,7 +49103,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/release.ts",
-        "line": 665
+        "line": 675
       },
       "name": "BranchOptions",
       "namespace": "release",
@@ -48913,7 +49117,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 675
+            "line": 685
           },
           "name": "majorVersion",
           "type": {
@@ -48929,7 +49133,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 680
+            "line": 690
           },
           "name": "minMajorVersion",
           "optional": true,
@@ -48947,7 +49151,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 708
+            "line": 718
           },
           "name": "npmDistTag",
           "optional": true,
@@ -48965,7 +49169,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 687
+            "line": 697
           },
           "name": "prerelease",
           "optional": true,
@@ -48984,7 +49188,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 701
+            "line": 711
           },
           "name": "tagPrefix",
           "optional": true,
@@ -49002,7 +49206,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 670
+            "line": 680
           },
           "name": "workflowName",
           "optional": true,
@@ -50721,7 +50925,7 @@
         },
         "locationInModule": {
           "filename": "src/release/release.ts",
-          "line": 302
+          "line": 310
         },
         "parameters": [
           {
@@ -50741,7 +50945,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/release/release.ts",
-        "line": 264
+        "line": 272
       },
       "methods": [
         {
@@ -50751,7 +50955,7 @@
           },
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 271
+            "line": 279
           },
           "name": "of",
           "parameters": [
@@ -50778,7 +50982,7 @@
           },
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 424
+            "line": 433
           },
           "name": "addBranch",
           "parameters": [
@@ -50809,7 +51013,7 @@
           },
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 491
+            "line": 500
           },
           "name": "addJobs",
           "parameters": [
@@ -50836,7 +51040,7 @@
           },
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 474
+            "line": 483
           },
           "name": "preSynthesize",
           "overrides": "projen.Component"
@@ -50853,7 +51057,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 265
+            "line": 273
           },
           "name": "ANTI_TAMPER_CMD",
           "static": true,
@@ -50869,7 +51073,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 300
+            "line": 308
           },
           "name": "artifactsDirectory",
           "type": {
@@ -50884,7 +51088,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 500
+            "line": 509
           },
           "name": "branches",
           "type": {
@@ -50904,7 +51108,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 279
+            "line": 287
           },
           "name": "publisher",
           "type": {
@@ -50928,7 +51132,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/release.ts",
-        "line": 204
+        "line": 212
       },
       "name": "ReleaseOptions",
       "namespace": "release",
@@ -50943,7 +51147,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 241
+            "line": 249
           },
           "name": "artifactsDirectory",
           "type": {
@@ -50960,7 +51164,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 227
+            "line": 235
           },
           "name": "branch",
           "type": {
@@ -50977,7 +51181,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 210
+            "line": 218
           },
           "name": "task",
           "type": {
@@ -50994,7 +51198,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 217
+            "line": 225
           },
           "name": "versionFile",
           "type": {
@@ -51011,7 +51215,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 234
+            "line": 242
           },
           "name": "githubRelease",
           "optional": true,
@@ -51030,7 +51234,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 250
+            "line": 258
           },
           "name": "workflowNodeVersion",
           "optional": true,
@@ -51048,7 +51252,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/release.ts",
-            "line": 256
+            "line": 264
           },
           "name": "workflowPermissions",
           "optional": true,
@@ -51228,6 +51432,24 @@
             "primitive": "boolean"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "ReleasableCommits.everyCommit()",
+            "stability": "experimental",
+            "summary": "Find commits that should be considered releasable Used to decide if a release is required."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/release/release.ts",
+            "line": 206
+          },
+          "name": "releasableCommits",
+          "optional": true,
+          "type": {
+            "fqn": "projen.ReleasableCommits"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -55001,6 +55223,6 @@
       "symbolId": "src/web/tailwind:TailwindConfigOptions"
     }
   },
-  "version": "0.71.112",
-  "fingerprint": "/leQ/Uw5ydrZ9sa+NbpOeXxU0OIYolrQ6y6cL21js0Q="
+  "version": "0.71.113",
+  "fingerprint": "n2slPItwHlBA3f7UnqaOz5DpANMGBE4kRvmLeKGDp6g="
 }