fix: projen upgrade workflow corrupted

.github/workflows/upgrade-projen.yml → .github/workflows/projenupgrade.yml

@@ -1,5 +1,5 @@
 # Generated by projen. To modify, edit .projenrc.js and run "npx projen".
-name: upgrade-projen
+name: ProjenUpgrade
 on:
   schedule:
     - cron: 0 6 * * *
@@ -18,7 +18,8 @@ jobs:
       - run: yarn projen:upgrade
       - name: Create Pull Request
         uses: peter-evans/create-pull-request@v3
-        commit-message: "chore: upgrade projen"
-        branch: auto/projen-upgrade
-        title: "chore: upgrade projen"
-        body: This PR upgrades projen to the latest version
+        with:
+          commit-message: "chore: upgrade projen"
+          branch: auto/projen-upgrade
+          title: "chore: upgrade projen"
+          body: This PR upgrades projen to the latest version

.gitignore

@@ -60,7 +60,7 @@ tsconfig.json
 !# synthesized by projen, (do not modify by hand)
 !/.github/dependabot.yml
 !# synthesized by projen, (do not modify by hand)
-!/.github/workflows/upgrade-projen.yml
+!/.github/workflows/projenupgrade.yml
 !/src
 !# synthesized by projen, (do not modify by hand)
 !/.eslintrc.json

API.md

@@ -488,6 +488,7 @@ new JsiiProject(options: JsiiProjectOptions)
   * **peerDependencies** (<code>Map<string, [Semver](#projen-semver)></code>)  *No description* __*Optional*__
   * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>)  *No description* __*Optional*__
   * **projenDevDependency** (<code>boolean</code>)  Indicates of "projen" should be installed as a devDependency. __*Default*__: true
+  * **projenUpgrade** (<code>boolean</code>)  Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade. __*Default*__: true
   * **projenVersion** (<code>[Semver](#projen-semver)</code>)  Version of projen to install. __*Default*__: latest version
   * **releaseBranches** (<code>Array<string></code>)  Branches which trigger a release. __*Default*__: [ "master" ]
   * **releaseEveryCommit** (<code>boolean</code>)  Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
@@ -734,6 +735,7 @@ new NodeProject(options: NodeProjectOptions)
   * **peerDependencies** (<code>Map<string, [Semver](#projen-semver)></code>)  *No description* __*Optional*__
   * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>)  *No description* __*Optional*__
   * **projenDevDependency** (<code>boolean</code>)  Indicates of "projen" should be installed as a devDependency. __*Default*__: true
+  * **projenUpgrade** (<code>boolean</code>)  Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade. __*Default*__: true
   * **projenVersion** (<code>[Semver](#projen-semver)</code>)  Version of projen to install. __*Default*__: latest version
   * **releaseBranches** (<code>Array<string></code>)  Branches which trigger a release. __*Default*__: [ "master" ]
   * **releaseEveryCommit** (<code>boolean</code>)  Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
@@ -1079,6 +1081,7 @@ new TypeScriptLibraryProject(options: TypeScriptProjectOptions)
   * **peerDependencies** (<code>Map<string, [Semver](#projen-semver)></code>)  *No description* __*Optional*__
   * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>)  *No description* __*Optional*__
   * **projenDevDependency** (<code>boolean</code>)  Indicates of "projen" should be installed as a devDependency. __*Default*__: true
+  * **projenUpgrade** (<code>boolean</code>)  Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade. __*Default*__: true
   * **projenVersion** (<code>[Semver](#projen-semver)</code>)  Version of projen to install. __*Default*__: latest version
   * **releaseBranches** (<code>Array<string></code>)  Branches which trigger a release. __*Default*__: [ "master" ]
   * **releaseEveryCommit** (<code>boolean</code>)  Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
@@ -1155,6 +1158,7 @@ new TypeScriptProject(options: TypeScriptProjectOptions)
   * **peerDependencies** (<code>Map<string, [Semver](#projen-semver)></code>)  *No description* __*Optional*__
   * **peerDependencyOptions** (<code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code>)  *No description* __*Optional*__
   * **projenDevDependency** (<code>boolean</code>)  Indicates of "projen" should be installed as a devDependency. __*Default*__: true
+  * **projenUpgrade** (<code>boolean</code>)  Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade. __*Default*__: true
   * **projenVersion** (<code>[Semver](#projen-semver)</code>)  Version of projen to install. __*Default*__: latest version
   * **releaseBranches** (<code>Array<string></code>)  Branches which trigger a release. __*Default*__: [ "master" ]
   * **releaseEveryCommit** (<code>boolean</code>)  Automatically release new versions every commit to one of branches in `releaseBranches`. __*Default*__: true
@@ -1456,6 +1460,7 @@ Name | Type | Description
 **peerDependencies**?🔹 | <code>Map<string, [Semver](#projen-semver)></code> | __*Optional*__
 **peerDependencyOptions**?🔹 | <code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code> | __*Optional*__
 **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
+**projenUpgrade**?🔹 | <code>boolean</code> | Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.<br/>__*Default*__: true
 **projenVersion**?🔹 | <code>[Semver](#projen-semver)</code> | Version of projen to install.<br/>__*Default*__: latest version
 **python**?🔹 | <code>[JsiiPythonTarget](#projen-jsiipythontarget)</code> | __*Optional*__
 **releaseBranches**?🔹 | <code>Array<string></code> | Branches which trigger a release.<br/>__*Default*__: [ "master" ]
@@ -1593,6 +1598,7 @@ Name | Type | Description
 **peerDependencies**?🔹 | <code>Map<string, [Semver](#projen-semver)></code> | __*Optional*__
 **peerDependencyOptions**?🔹 | <code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code> | __*Optional*__
 **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
+**projenUpgrade**?🔹 | <code>boolean</code> | Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.<br/>__*Default*__: true
 **projenVersion**?🔹 | <code>[Semver](#projen-semver)</code> | Version of projen to install.<br/>__*Default*__: latest version
 **releaseBranches**?🔹 | <code>Array<string></code> | Branches which trigger a release.<br/>__*Default*__: [ "master" ]
 **releaseEveryCommit**?🔹 | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true
@@ -1649,6 +1655,7 @@ Name | Type | Description
 **peerDependencies**?🔹 | <code>Map<string, [Semver](#projen-semver)></code> | __*Optional*__
 **peerDependencyOptions**?🔹 | <code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code> | __*Optional*__
 **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
+**projenUpgrade**?🔹 | <code>boolean</code> | Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.<br/>__*Default*__: true
 **projenVersion**?🔹 | <code>[Semver](#projen-semver)</code> | Version of projen to install.<br/>__*Default*__: latest version
 **releaseBranches**?🔹 | <code>Array<string></code> | Branches which trigger a release.<br/>__*Default*__: [ "master" ]
 **releaseEveryCommit**?🔹 | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true
@@ -1763,6 +1770,7 @@ Name | Type | Description
 **peerDependencies**?⚠️ | <code>Map<string, [Semver](#projen-semver)></code> | __*Optional*__
 **peerDependencyOptions**?⚠️ | <code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code> | __*Optional*__
 **projenDevDependency**?⚠️ | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
+**projenUpgrade**?⚠️ | <code>boolean</code> | Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.<br/>__*Default*__: true
 **projenVersion**?⚠️ | <code>[Semver](#projen-semver)</code> | Version of projen to install.<br/>__*Default*__: latest version
 **releaseBranches**?⚠️ | <code>Array<string></code> | Branches which trigger a release.<br/>__*Default*__: [ "master" ]
 **releaseEveryCommit**?⚠️ | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true
@@ -1831,6 +1839,7 @@ Name | Type | Description
 **peerDependencies**?🔹 | <code>Map<string, [Semver](#projen-semver)></code> | __*Optional*__
 **peerDependencyOptions**?🔹 | <code>[PeerDependencyOptions](#projen-peerdependencyoptions)</code> | __*Optional*__
 **projenDevDependency**?🔹 | <code>boolean</code> | Indicates of "projen" should be installed as a devDependency.<br/>__*Default*__: true
+**projenUpgrade**?🔹 | <code>boolean</code> | Define a `projen:upgrade` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.<br/>__*Default*__: true
 **projenVersion**?🔹 | <code>[Semver](#projen-semver)</code> | Version of projen to install.<br/>__*Default*__: latest version
 **releaseBranches**?🔹 | <code>Array<string></code> | Branches which trigger a release.<br/>__*Default*__: [ "master" ]
 **releaseEveryCommit**?🔹 | <code>boolean</code> | Automatically release new versions every commit to one of branches in `releaseBranches`.<br/>__*Default*__: true

src/node-project.ts

@@ -210,6 +210,14 @@ export interface NodeProjectCommonOptions {
    * @default {}
    */
   readonly scripts?: { [name: string]: string }
+
+  /**
+   * Define a `projen:upgrade` script and a scheduled github workflow which will
+   * upgrade projen and submit a PR with the upgrade.
+   *
+   * @default true
+   */
+  readonly projenUpgrade?: boolean;
 }
 
 export interface NodeProjectOptions extends NodeProjectCommonOptions {
@@ -562,7 +570,9 @@ export class NodeProject extends Project {
       new Dependabot(this, options.dependabotOptions);
     }
 
-    new ProjenUpgrade(this);
+    if (options.projenUpgrade ?? true) {
+      new ProjenUpgrade(this);
+    }
 
     // override any scripts from options (if specified)
     for (const [n, v] of Object.entries(options.scripts ?? {})) {

src/projen-upgrade.ts

@@ -14,7 +14,7 @@ export class ProjenUpgrade {
       'chmod -w package.json',
       'yarn projen');
 
-    const workflow = new GithubWorkflow(project, 'upgrade-projen');
+    const workflow = new GithubWorkflow(project, 'ProjenUpgrade');
 
     workflow.on({
       schedule: [ { cron: '0 6 * * *' } ], // 6am every day
@@ -32,12 +32,14 @@ export class ProjenUpgrade {
 
           // submit a PR
           {
-            'name': 'Create Pull Request',
-            'uses': 'peter-evans/create-pull-request@v3',
-            'commit-message': 'chore: upgrade projen',
-            'branch': 'auto/projen-upgrade',
-            'title': 'chore: upgrade projen',
-            'body': 'This PR upgrades projen to the latest version',
+            name: 'Create Pull Request',
+            uses: 'peter-evans/create-pull-request@v3',
+            with: {
+              'commit-message': 'chore: upgrade projen',
+              'branch': 'auto/projen-upgrade',
+              'title': 'chore: upgrade projen',
+              'body': 'This PR upgrades projen to the latest version',
+            },
           },
         ],
       },

test/__snapshots__/inventory.test.ts.snap

@@ -877,6 +877,17 @@ Array [
         "switch": "projen-dev-dependency",
         "type": "boolean",
       },
+      Object {
+        "default": "true",
+        "docs": "Define a \`projen:upgrade\` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.",
+        "name": "projenUpgrade",
+        "optional": true,
+        "path": Array [
+          "projenUpgrade",
+        ],
+        "switch": "projen-upgrade",
+        "type": "boolean",
+      },
       Object {
         "name": "mode",
         "optional": true,
@@ -1438,6 +1449,17 @@ Array [
         "switch": "projen-dev-dependency",
         "type": "boolean",
       },
+      Object {
+        "default": "true",
+        "docs": "Define a \`projen:upgrade\` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.",
+        "name": "projenUpgrade",
+        "optional": true,
+        "path": Array [
+          "projenUpgrade",
+        ],
+        "switch": "projen-upgrade",
+        "type": "boolean",
+      },
       Object {
         "name": "mode",
         "optional": true,
@@ -2475,6 +2497,17 @@ jest typescript tests and only if all tests pass, run the compiler.",
         "switch": "projen-dev-dependency",
         "type": "boolean",
       },
+      Object {
+        "default": "true",
+        "docs": "Define a \`projen:upgrade\` script and a scheduled github workflow which will upgrade projen and submit a PR with the upgrade.",
+        "name": "projenUpgrade",
+        "optional": true,
+        "path": Array [
+          "projenUpgrade",
+        ],
+        "switch": "projen-upgrade",
+        "type": "boolean",
+      },
       Object {
         "name": "mode",
         "optional": true,