projen 0.57.7 → 0.57.10

package/.jsii

@@ -40992,7 +40992,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 733
+        "line": 752
       },
       "name": "CodeArtifactOptions",
       "namespace": "release",
@@ -41008,7 +41008,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 740
+            "line": 759
           },
           "name": "accessKeyIdSecret",
           "optional": true,
@@ -41026,7 +41026,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 756
+            "line": 775
           },
           "name": "roleToAssume",
           "optional": true,
@@ -41045,7 +41045,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 748
+            "line": 767
           },
           "name": "secretAccessKeySecret",
           "optional": true,
@@ -41067,7 +41067,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 658
+        "line": 677
       },
       "name": "CommonPublishOptions",
       "namespace": "release",
@@ -41082,7 +41082,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 668
+            "line": 687
           },
           "name": "prePublishSteps",
           "optional": true,
@@ -41105,7 +41105,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 674
+            "line": 693
           },
           "name": "publishTools",
           "optional": true,
@@ -41130,7 +41130,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 982
+        "line": 1021
       },
       "name": "GitHubReleasesPublishOptions",
       "namespace": "release",
@@ -41145,7 +41145,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 967
+            "line": 1006
           },
           "name": "changelogFile",
           "type": {
@@ -41162,7 +41162,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 960
+            "line": 999
           },
           "name": "releaseTagFile",
           "type": {
@@ -41179,7 +41179,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 953
+            "line": 992
           },
           "name": "versionFile",
           "type": {
@@ -41200,7 +41200,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 989
+        "line": 1028
       },
       "name": "GitPublishOptions",
       "namespace": "release",
@@ -41215,7 +41215,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 967
+            "line": 1006
           },
           "name": "changelogFile",
           "type": {
@@ -41232,7 +41232,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 960
+            "line": 999
           },
           "name": "releaseTagFile",
           "type": {
@@ -41249,7 +41249,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 953
+            "line": 992
           },
           "name": "versionFile",
           "type": {
@@ -41266,7 +41266,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 1000
+            "line": 1039
           },
           "name": "gitBranch",
           "optional": true,
@@ -41284,7 +41284,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 1007
+            "line": 1046
           },
           "name": "gitPushCommand",
           "optional": true,
@@ -41301,7 +41301,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 993
+            "line": 1032
           },
           "name": "projectChangelogFile",
           "optional": true,
@@ -41316,8 +41316,8 @@
       "assembly": "projen",
       "datatype": true,
       "docs": {
-        "deprecated": "Use `GoPublishOptions` instead.\nexport interface JsiiReleaseGo extends GoPublishOptions { }\n/**\nOptions for Go releases.",
-        "stability": "deprecated"
+        "stability": "experimental",
+        "summary": "Options for Go releases."
       },
       "fqn": "projen.release.GoPublishOptions",
       "interfaces": [
@@ -41326,7 +41326,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 904
+        "line": 924
       },
       "name": "GoPublishOptions",
       "namespace": "release",
@@ -41335,13 +41335,13 @@
           "abstract": true,
           "docs": {
             "default": "\"main\"",
-            "stability": "deprecated",
+            "stability": "experimental",
             "summary": "Branch to push to."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 925
+            "line": 964
           },
           "name": "gitBranch",
           "optional": true,
@@ -41353,13 +41353,13 @@
           "abstract": true,
           "docs": {
             "default": "\"chore(release): $VERSION\"",
-            "stability": "deprecated",
+            "stability": "experimental",
             "summary": "The commit message."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 944
+            "line": 983
           },
           "name": "gitCommitMessage",
           "optional": true,
@@ -41367,17 +41367,36 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "\"GO_GITHUB_DEPLOY_KEY\"",
+            "remarks": "Ignored if `githubUseSsh` is `false`.",
+            "stability": "experimental",
+            "summary": "The name of the secret that includes a GitHub deploy key used to push to the GitHub repository."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/release/publisher.ts",
+            "line": 943
+          },
+          "name": "githubDeployKeySecret",
+          "optional": true,
+          "type": {
+            "primitive": "string"
+          }
+        },
         {
           "abstract": true,
           "docs": {
             "default": "- derived from `moduleName`",
-            "stability": "deprecated",
+            "stability": "experimental",
             "summary": "GitHub repository to push to."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 918
+            "line": 957
           },
           "name": "githubRepo",
           "optional": true,
@@ -41389,13 +41408,14 @@
           "abstract": true,
           "docs": {
             "default": "\"GO_GITHUB_TOKEN\"",
-            "stability": "deprecated",
+            "remarks": "Ignored if `githubUseSsh` is `true`.",
+            "stability": "experimental",
             "summary": "The name of the secret that includes a personal GitHub access token used to push to the GitHub repository."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 911
+            "line": 933
           },
           "name": "githubTokenSecret",
           "optional": true,
@@ -41403,6 +41423,24 @@
             "primitive": "string"
           }
         },
+        {
+          "abstract": true,
+          "docs": {
+            "default": "false",
+            "stability": "experimental",
+            "summary": "Use SSH to push to GitHub instead of a personal accses token."
+          },
+          "immutable": true,
+          "locationInModule": {
+            "filename": "src/release/publisher.ts",
+            "line": 950
+          },
+          "name": "githubUseSsh",
+          "optional": true,
+          "type": {
+            "primitive": "boolean"
+          }
+        },
         {
           "abstract": true,
           "docs": {
@@ -41410,13 +41448,13 @@
               "github": ".com\""
             },
             "default": "\"github-actions",
-            "stability": "deprecated",
+            "stability": "experimental",
             "summary": "The email to use in the release git commit."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 937
+            "line": 976
           },
           "name": "gitUserEmail",
           "optional": true,
@@ -41428,13 +41466,13 @@
           "abstract": true,
           "docs": {
             "default": "\"github-actions\"",
-            "stability": "deprecated",
+            "stability": "experimental",
             "summary": "The user name to use for the release git commit."
           },
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 931
+            "line": 970
           },
           "name": "gitUserName",
           "optional": true,
@@ -41445,6 +41483,26 @@
       ],
       "symbolId": "src/release/publisher:GoPublishOptions"
     },
+    "projen.release.JsiiReleaseGo": {
+      "assembly": "projen",
+      "datatype": true,
+      "docs": {
+        "deprecated": "Use `GoPublishOptions` instead.",
+        "stability": "deprecated"
+      },
+      "fqn": "projen.release.JsiiReleaseGo",
+      "interfaces": [
+        "projen.release.GoPublishOptions"
+      ],
+      "kind": "interface",
+      "locationInModule": {
+        "filename": "src/release/publisher.ts",
+        "line": 919
+      },
+      "name": "JsiiReleaseGo",
+      "namespace": "release",
+      "symbolId": "src/release/publisher:JsiiReleaseGo"
+    },
     "projen.release.JsiiReleaseMaven": {
       "assembly": "projen",
       "datatype": true,
@@ -41459,7 +41517,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 813
+        "line": 832
       },
       "name": "JsiiReleaseMaven",
       "namespace": "release",
@@ -41479,7 +41537,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 680
+        "line": 699
       },
       "name": "JsiiReleaseNpm",
       "namespace": "release",
@@ -41499,7 +41557,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 791
+        "line": 810
       },
       "name": "JsiiReleaseNuget",
       "namespace": "release",
@@ -41519,7 +41577,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 762
+        "line": 781
       },
       "name": "JsiiReleasePyPi",
       "namespace": "release",
@@ -41612,7 +41670,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 818
+        "line": 837
       },
       "name": "MavenPublishOptions",
       "namespace": "release",
@@ -41628,7 +41686,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 824
+            "line": 843
           },
           "name": "mavenEndpoint",
           "optional": true,
@@ -41648,7 +41706,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 857
+            "line": 876
           },
           "name": "mavenGpgPrivateKeyPassphrase",
           "optional": true,
@@ -41668,7 +41726,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 848
+            "line": 867
           },
           "name": "mavenGpgPrivateKeySecret",
           "optional": true,
@@ -41688,7 +41746,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 883
+            "line": 902
           },
           "name": "mavenPassword",
           "optional": true,
@@ -41706,7 +41764,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 838
+            "line": 857
           },
           "name": "mavenRepositoryUrl",
           "optional": true,
@@ -41724,7 +41782,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 831
+            "line": 850
           },
           "name": "mavenServerId",
           "optional": true,
@@ -41742,7 +41800,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 894
+            "line": 913
           },
           "name": "mavenStagingProfileId",
           "optional": true,
@@ -41762,7 +41820,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 870
+            "line": 889
           },
           "name": "mavenUsername",
           "optional": true,
@@ -41787,7 +41845,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 685
+        "line": 704
       },
       "name": "NpmPublishOptions",
       "namespace": "release",
@@ -41802,7 +41860,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 730
+            "line": 749
           },
           "name": "codeArtifactOptions",
           "optional": true,
@@ -41822,7 +41880,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 703
+            "line": 722
           },
           "name": "distTag",
           "optional": true,
@@ -41840,7 +41898,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 723
+            "line": 742
           },
           "name": "npmTokenSecret",
           "optional": true,
@@ -41860,7 +41918,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 717
+            "line": 736
           },
           "name": "registry",
           "optional": true,
@@ -41885,7 +41943,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 796
+        "line": 815
       },
       "name": "NugetPublishOptions",
       "namespace": "release",
@@ -41900,7 +41958,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 802
+            "line": 821
           },
           "name": "nugetApiKeySecret",
           "optional": true,
@@ -41917,7 +41975,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 807
+            "line": 826
           },
           "name": "nugetServer",
           "optional": true,
@@ -42468,7 +42526,7 @@
       "kind": "interface",
       "locationInModule": {
         "filename": "src/release/publisher.ts",
-        "line": 767
+        "line": 786
       },
       "name": "PyPiPublishOptions",
       "namespace": "release",
@@ -42483,7 +42541,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 785
+            "line": 804
           },
           "name": "twinePasswordSecret",
           "optional": true,
@@ -42501,7 +42559,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 773
+            "line": 792
           },
           "name": "twineRegistryUrl",
           "optional": true,
@@ -42519,7 +42577,7 @@
           "immutable": true,
           "locationInModule": {
             "filename": "src/release/publisher.ts",
-            "line": 779
+            "line": 798
           },
           "name": "twineUsernameSecret",
           "optional": true,
@@ -46001,6 +46059,6 @@
       "symbolId": "src/web/tailwind:TailwindConfigOptions"
     }
   },
-  "version": "0.57.7",
-  "fingerprint": "6C/ijuWAuavDnTRCVM0iRtTtfPWWJu+ib1x5pGBPBqw="
+  "version": "0.57.10",
+  "fingerprint": "xfcwoGhmkhAgPyvlCISL4Dd/MJwFjgIo0STxG/k88xs="
 }

package/docs/api/API.md

@@ -329,7 +329,8 @@ Name|Description
 [release.CommonPublishOptions](#projen-release-commonpublishoptions)|Common publishing options.
 [release.GitHubReleasesPublishOptions](#projen-release-githubreleasespublishoptions)|Publishing options for GitHub releases.
 [release.GitPublishOptions](#projen-release-gitpublishoptions)|Publishing options for Git releases.
-[release.GoPublishOptions](#projen-release-gopublishoptions)|*No description*
+[release.GoPublishOptions](#projen-release-gopublishoptions)|Options for Go releases.
+[release.JsiiReleaseGo](#projen-release-jsiireleasego)|*No description*
 [release.JsiiReleaseMaven](#projen-release-jsiireleasemaven)|*No description*
 [release.JsiiReleaseNpm](#projen-release-jsiireleasenpm)|*No description*
 [release.JsiiReleaseNuget](#projen-release-jsiireleasenuget)|*No description*
@@ -9079,8 +9080,10 @@ publishToGo(options?: GoPublishOptions): void
   * **publishTools** (<code>[github.workflows.Tools](#projen-github-workflows-tools)</code>)  Additional tools to install in the publishing job. __*Default*__: no additional tools are installed
   * **gitBranch** (<code>string</code>)  Branch to push to. __*Default*__: "main"
   * **gitCommitMessage** (<code>string</code>)  The commit message. __*Default*__: "chore(release): $VERSION"
+  * **githubDeployKeySecret** (<code>string</code>)  The name of the secret that includes a GitHub deploy key used to push to the GitHub repository. __*Default*__: "GO_GITHUB_DEPLOY_KEY"
   * **githubRepo** (<code>string</code>)  GitHub repository to push to. __*Default*__: derived from `moduleName`
   * **githubTokenSecret** (<code>string</code>)  The name of the secret that includes a personal GitHub access token used to push to the GitHub repository. __*Default*__: "GO_GITHUB_TOKEN"
+  * **githubUseSsh** (<code>boolean</code>)  Use SSH to push to GitHub instead of a personal accses token. __*Default*__: false
   * **gitUserEmail** (<code>string</code>)  The email to use in the release git commit. __*Default*__: "github-actions
   * **gitUserName** (<code>string</code>)  The user name to use for the release git commit. __*Default*__: "github-actions"
 
@@ -13043,12 +13046,14 @@ Go target configuration.
 Name | Type | Description 
 -----|------|-------------
 **moduleName**🔹 | <code>string</code> | The name of the target go module.
-**gitBranch**?⚠️ | <code>string</code> | Branch to push to.<br/>__*Default*__: "main"
-**gitCommitMessage**?⚠️ | <code>string</code> | The commit message.<br/>__*Default*__: "chore(release): $VERSION"
-**gitUserEmail**?⚠️ | <code>string</code> | The email to use in the release git commit.<br/>__*Default*__: "github-actions
-**gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
-**githubRepo**?⚠️ | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
-**githubTokenSecret**?⚠️ | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
+**gitBranch**?🔹 | <code>string</code> | Branch to push to.<br/>__*Default*__: "main"
+**gitCommitMessage**?🔹 | <code>string</code> | The commit message.<br/>__*Default*__: "chore(release): $VERSION"
+**gitUserEmail**?🔹 | <code>string</code> | The email to use in the release git commit.<br/>__*Default*__: "github-actions
+**gitUserName**?🔹 | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
+**githubDeployKeySecret**?🔹 | <code>string</code> | The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_DEPLOY_KEY"
+**githubRepo**?🔹 | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
+**githubTokenSecret**?🔹 | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
+**githubUseSsh**?🔹 | <code>boolean</code> | Use SSH to push to GitHub instead of a personal accses token.<br/>__*Default*__: false
 **prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
 **publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
 
@@ -16028,7 +16033,29 @@ Name | Type | Description
 
 
 
-## struct GoPublishOptions ⚠️ <a id="projen-release-gopublishoptions"></a>
+## struct GoPublishOptions 🔹 <a id="projen-release-gopublishoptions"></a>
+
+
+Options for Go releases.
+
+
+
+Name | Type | Description 
+-----|------|-------------
+**gitBranch**?🔹 | <code>string</code> | Branch to push to.<br/>__*Default*__: "main"
+**gitCommitMessage**?🔹 | <code>string</code> | The commit message.<br/>__*Default*__: "chore(release): $VERSION"
+**gitUserEmail**?🔹 | <code>string</code> | The email to use in the release git commit.<br/>__*Default*__: "github-actions
+**gitUserName**?🔹 | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
+**githubDeployKeySecret**?🔹 | <code>string</code> | The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_DEPLOY_KEY"
+**githubRepo**?🔹 | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
+**githubTokenSecret**?🔹 | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
+**githubUseSsh**?🔹 | <code>boolean</code> | Use SSH to push to GitHub instead of a personal accses token.<br/>__*Default*__: false
+**prePublishSteps**?🔹 | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
+**publishTools**?🔹 | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed
+
+
+
+## struct JsiiReleaseGo ⚠️ <a id="projen-release-jsiireleasego"></a>
 
 
 
@@ -16041,8 +16068,10 @@ Name | Type | Description
 **gitCommitMessage**?⚠️ | <code>string</code> | The commit message.<br/>__*Default*__: "chore(release): $VERSION"
 **gitUserEmail**?⚠️ | <code>string</code> | The email to use in the release git commit.<br/>__*Default*__: "github-actions
 **gitUserName**?⚠️ | <code>string</code> | The user name to use for the release git commit.<br/>__*Default*__: "github-actions"
+**githubDeployKeySecret**?⚠️ | <code>string</code> | The name of the secret that includes a GitHub deploy key used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_DEPLOY_KEY"
 **githubRepo**?⚠️ | <code>string</code> | GitHub repository to push to.<br/>__*Default*__: derived from `moduleName`
 **githubTokenSecret**?⚠️ | <code>string</code> | The name of the secret that includes a personal GitHub access token used to push to the GitHub repository.<br/>__*Default*__: "GO_GITHUB_TOKEN"
+**githubUseSsh**?⚠️ | <code>boolean</code> | Use SSH to push to GitHub instead of a personal accses token.<br/>__*Default*__: false
 **prePublishSteps**?⚠️ | <code>Array<[github.workflows.JobStep](#projen-github-workflows-jobstep)></code> | Steps to execute before executing the publishing command. These can be used to prepare the artifact for publishing if neede.<br/>__*Optional*__
 **publishTools**?⚠️ | <code>[github.workflows.Tools](#projen-github-workflows-tools)</code> | Additional tools to install in the publishing job.<br/>__*Default*__: no additional tools are installed