@hallcor/pulumi-projen-project-types 0.0.0 → 0.0.2

package/.jsii

@@ -123,7 +123,7 @@
         },
         "locationInModule": {
           "filename": "src/python.ts",
-          "line": 10
+          "line": 9
         },
         "parameters": [
           {
@@ -137,7 +137,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/python.ts",
-        "line": 9
+        "line": 8
       },
       "name": "PythonComponent",
       "symbolId": "src/python:PythonComponent"
@@ -984,6 +984,24 @@
             "fqn": "projen.SampleReadmeProps"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "Continuous releases (`ReleaseTrigger.continuous()`)",
+            "stability": "experimental",
+            "summary": "The release trigger to use."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/PythonComponentOptions.ts",
+            "line": 356
+          },
+          "name": "releaseTrigger",
+          "optional": true,
+          "type": {
+            "fqn": "projen.release.ReleaseTrigger"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -1151,7 +1169,7 @@
         },
         "locationInModule": {
           "filename": "src/release.ts",
-          "line": 9
+          "line": 10
         },
         "parameters": [
           {
@@ -1171,7 +1189,7 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/release.ts",
-        "line": 8
+        "line": 9
       },
       "name": "ReleaseWorkflow",
       "symbolId": "src/release:ReleaseWorkflow"
@@ -1189,7 +1207,7 @@
         },
         "locationInModule": {
           "filename": "src/release.ts",
-          "line": 66
+          "line": 70
         },
         "parameters": [
           {
@@ -1201,7 +1219,7 @@
           {
             "name": "props",
             "type": {
-              "fqn": "projen.release.ReleaseOptions"
+              "fqn": "@hallcor/pulumi-projen-project-types.TagReleaseOptions"
             }
           }
         ]
@@ -1209,11 +1227,661 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/release.ts",
-        "line": 65
+        "line": 68
       },
       "name": "TagRelease",
+      "properties": [
+        {
+          "docs": {
+            "stability": "stable"
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/release.ts",
+            "line": 69
+          },
+          "name": "publishTask",
+          "type": {
+            "fqn": "projen.Task"
+          }
+        }
+      ],
       "symbolId": "src/release:TagRelease"
     },
+    "@hallcor/pulumi-projen-project-types.TagReleaseOptions": {
+      "assembly": "@hallcor/pulumi-projen-project-types",
+      "datatype": true,
+      "docs": {
+        "stability": "stable",
+        "summary": "TagReleaseOptions."
+      },
+      "fqn": "@hallcor/pulumi-projen-project-types.TagReleaseOptions",
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/TagReleaseOptions.ts",
+        "line": 7
+      },
+      "name": "TagReleaseOptions",
+      "properties": [
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"dist\"",
+            "stability": "experimental",
+            "summary": "A directory which will contain build artifacts."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 55
+          },
+          "name": "artifactsDirectory",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Use `majorVersion` to restrict this branch to only publish releases with a\nspecific major version.\n\nYou can add additional branches using `addBranch()`.",
+            "stability": "experimental",
+            "summary": "The default branch name to release from."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 49
+          },
+          "name": "branch",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "remarks": "Artifacts are\nexpected to reside under `artifactsDirectory` (defaults to `dist/`) once\nbuild is complete.",
+            "stability": "experimental",
+            "summary": "The task to execute in order to create the release artifacts."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 40
+          },
+          "name": "task",
+          "type": {
+            "fqn": "projen.Task"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "A name of a .json file to set the `version` field in after a bump."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 32
+          },
+          "name": "versionFile",
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "package.json",
+            "remarks": "Must be a commit-and-tag-version compatible bump file",
+            "stability": "stable",
+            "summary": "The file to bump the version in."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 249
+          },
+          "name": "bumpFile",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- A recent version of \"commit-and-tag-version\"",
+            "remarks": "This can be any compatible package version, including the deprecated `standard-version@9`.",
+            "stability": "experimental",
+            "summary": "The `commit-and-tag-version` compatible package used to bump the package version, as a dependency string."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 244
+          },
+          "name": "bumpPackage",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "stability": "experimental",
+            "summary": "Create a GitHub release for each release."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 27
+          },
+          "name": "githubRelease",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"latest\"",
+            "stability": "experimental",
+            "summary": "Version requirement of `publib` which is used to publish modules to npm."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 237
+          },
+          "name": "jsiiReleaseVersion",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Major version is not enforced.",
+            "remarks": "If this is specified, we bump the latest version of this major version line.\nIf not specified, we bump the global latest version.",
+            "stability": "experimental",
+            "summary": "Major version to release from the default branch."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 231
+          },
+          "name": "majorVersion",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- No minimum version is being enforced",
+            "remarks": "This can be useful to set to 1, as breaking changes before the 1.x major\nrelease are not incrementing the major version number.\n\nCan not be set together with `majorVersion`.",
+            "stability": "experimental",
+            "summary": "Minimal Major version to release."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 223
+          },
+          "name": "minMajorVersion",
+          "optional": true,
+          "type": {
+            "primitive": "number"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- The next version will be determined based on the commit history and project settings.",
+            "remarks": "If present, this shell command will be run before the bump is executed, and\nit determines what version to release. It will be executed in the following\nenvironment:\n\n- Working directory: the project directory.\n- `$VERSION`: the current version. Looks like `1.2.3`.\n- `$LATEST_TAG`: the most recent tag. Looks like `prefix-v1.2.3`, or may be unset.\n\nThe command should print one of the following to `stdout`:\n\n- Nothing: the next version number will be determined based on commit history.\n- `x.y.z`: the next version number will be `x.y.z`.\n- `major|minor|patch`: the next version number will be the current version number\n  with the indicated component bumped.\n\nThis setting cannot be specified together with `minMajorVersion`; the invoked\nscript can be used to achieve the effects of `minMajorVersion`.",
+            "stability": "experimental",
+            "summary": "A shell command to control the next version to release."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 213
+          },
+          "name": "nextVersionCommand",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"latest\"",
+            "remarks": "To set the npm dist-tag for release branches, set the `npmDistTag` property\nfor each branch.",
+            "stability": "experimental",
+            "summary": "The npmDistTag to use when publishing from the default branch."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 190
+          },
+          "name": "npmDistTag",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "[]",
+            "stability": "experimental",
+            "summary": "Steps to execute after build as part of the release workflow."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 182
+          },
+          "name": "postBuildSteps",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.github.workflows.JobStep"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- normal semantic versions",
+            "stability": "experimental",
+            "summary": "Bump versions from the default branch as pre-releases (e.g. \"beta\", \"alpha\", \"pre\")."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 176
+          },
+          "name": "prerelease",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "stability": "experimental",
+            "summary": "Instead of actually publishing to package managers, just print the publishing command."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 170
+          },
+          "name": "publishDryRun",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "remarks": "Normally, publishing only happens within automated workflows. Enable this\nin order to create a publishing task for each publishing activity.",
+            "stability": "experimental",
+            "summary": "Define publishing tasks that can be executed manually as well as workflows."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 164
+          },
+          "name": "publishTasks",
+          "optional": true,
+          "type": {
+            "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/TagReleaseOptions.ts",
+            "line": 156
+          },
+          "name": "releasableCommits",
+          "optional": true,
+          "type": {
+            "fqn": "projen.ReleasableCommits"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no additional branches are used for release. you can use\n`addBranch()` to add additional branches.",
+            "remarks": "A workflow will be created for each\nrelease branch which will publish releases from commits in this branch.\nEach release branch _must_ be assigned a major version number which is used\nto enforce that versions published from that branch always use that major\nversion. If multiple branches are used, the `majorVersion` field must also\nbe provided for the default branch.",
+            "stability": "experimental",
+            "summary": "Defines additional release branches."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 150
+          },
+          "name": "releaseBranches",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.release.BranchOptions"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "true",
+            "deprecated": "Use `releaseTrigger: ReleaseTrigger.continuous()` instead",
+            "stability": "deprecated",
+            "summary": "Automatically release new versions every commit to one of branches in `releaseBranches`."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 137
+          },
+          "name": "releaseEveryCommit",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "stability": "experimental",
+            "summary": "Create a github issue on every failed publishing task."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 130
+          },
+          "name": "releaseFailureIssue",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"failed-release\"",
+            "remarks": "Only applies if `releaseFailureIssue` is true.",
+            "stability": "experimental",
+            "summary": "The label to apply to issues indicating publish failures."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 124
+          },
+          "name": "releaseFailureIssueLabel",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- no scheduled releases",
+            "deprecated": "Use `releaseTrigger: ReleaseTrigger.scheduled()` instead",
+            "stability": "deprecated",
+            "summary": "CRON schedule to trigger new releases."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 117
+          },
+          "name": "releaseSchedule",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"v\"",
+            "remarks": "Useful if you are releasing on multiple branches with overlapping version numbers.\nNote: this prefix is used to detect the latest tagged version\nwhen bumping, so if you change this on a project with an existing version\nhistory, you may need to manually tag your latest release\nwith the new prefix.",
+            "stability": "experimental",
+            "summary": "Automatically add the given prefix to release tags."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 110
+          },
+          "name": "releaseTagPrefix",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- Continuous releases (`ReleaseTrigger.continuous()`)",
+            "stability": "experimental",
+            "summary": "The release trigger to use."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 100
+          },
+          "name": "releaseTrigger",
+          "optional": true,
+          "type": {
+            "fqn": "projen.release.ReleaseTrigger"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"release\"",
+            "stability": "experimental",
+            "summary": "The name of the default release workflow."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 94
+          },
+          "name": "releaseWorkflowName",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "stability": "experimental",
+            "summary": "A set of workflow steps to execute in order to setup the workflow container."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 88
+          },
+          "name": "releaseWorkflowSetupSteps",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "fqn": "projen.github.workflows.JobStep"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- standard configuration applicable for GitHub repositories",
+            "remarks": "Given values either append to default configuration or overwrite values in it.",
+            "stability": "experimental",
+            "summary": "Custom configuration used when creating changelog with commit-and-tag-version package."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 83
+          },
+          "name": "versionrcOptions",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "any"
+              },
+              "kind": "map"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "- default image",
+            "stability": "experimental",
+            "summary": "Container image to use for GitHub workflows."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 76
+          },
+          "name": "workflowContainerImage",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"lts/*\"\"",
+            "remarks": "For example `publib`, the CLI projen uses to publish releases,\nis an npm library.",
+            "stability": "experimental",
+            "summary": "Node version to setup in GitHub workflows if any node-based CLI utilities are needed."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 21
+          },
+          "name": "workflowNodeVersion",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "`{ contents: JobPermission.WRITE }`",
+            "stability": "experimental",
+            "summary": "Permissions granted to the release workflow job."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 13
+          },
+          "name": "workflowPermissions",
+          "optional": true,
+          "type": {
+            "fqn": "projen.github.workflows.JobPermissions"
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "description": "Defines a target Runner by labels",
+              "throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
+            },
+            "default": "[\"ubuntu-latest\"]",
+            "stability": "experimental",
+            "summary": "Github Runner selection labels."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 70
+          },
+          "name": "workflowRunsOn",
+          "optional": true,
+          "type": {
+            "collection": {
+              "elementtype": {
+                "primitive": "string"
+              },
+              "kind": "array"
+            }
+          }
+        },
+        {
+          "abstract": true,
+          "docs": {
+            "custom": {
+              "description": "Defines a target Runner Group by name and/or labels",
+              "throws": "{Error} if both `runsOn` and `runsOnGroup` are specified"
+            },
+            "stability": "experimental",
+            "summary": "Github Runner Group selection options."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/TagReleaseOptions.ts",
+            "line": 62
+          },
+          "name": "workflowRunsOnGroup",
+          "optional": true,
+          "type": {
+            "fqn": "projen.GroupRunnerOptions"
+          }
+        }
+      ],
+      "symbolId": "src/TagReleaseOptions:TagReleaseOptions"
+    },
     "@hallcor/pulumi-projen-project-types.TypeScriptProject": {
       "assembly": "@hallcor/pulumi-projen-project-types",
       "base": "projen.typescript.TypeScriptProject",
@@ -1227,7 +1895,7 @@
         },
         "locationInModule": {
           "filename": "src/typescript-base.ts",
-          "line": 6
+          "line": 13
         },
         "parameters": [
           {
@@ -1241,12 +1909,12 @@
       "kind": "class",
       "locationInModule": {
         "filename": "src/typescript-base.ts",
-        "line": 5
+        "line": 12
       },
       "name": "TypeScriptProject",
       "symbolId": "src/typescript-base:TypeScriptProject"
     }
   },
-  "version": "0.0.0",
-  "fingerprint": "WUTjABadjY+/MY04y4w/IYWsZfuGMaJ7yfVe0QtHVsE="
+  "version": "0.0.2",
+  "fingerprint": "sR8FUdFmftZOiUL+Ih3PMt2nDMBRQ/VYrFeAMtezusY="
 }