@backstage/plugin-scaffolder-backend-module-github 0.7.2-next.1 → 0.8.0

package/dist/actions/githubWebhook.cjs.js

@@ -17,69 +17,35 @@ function createGithubWebhookAction(options) {
     supportsDryRun: true,
     schema: {
       input: {
-        type: "object",
-        required: ["repoUrl", "webhookUrl"],
-        properties: {
-          repoUrl: {
-            title: "Repository Location",
-            description: "Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username",
-            type: "string"
-          },
-          webhookUrl: {
-            title: "Webhook URL",
-            description: "The URL to which the payloads will be delivered",
-            type: "string"
-          },
-          webhookSecret: {
-            title: "Webhook Secret",
-            description: "Webhook secret value. The default can be provided internally in action creation",
-            type: "string"
-          },
-          events: {
-            title: "Triggering Events",
-            description: "Determines what events the hook is triggered for. Default: `[push]`",
-            type: "array",
-            default: ["push"],
-            oneOf: [
-              {
-                items: {
-                  type: "string",
-                  enum: eventNames
-                }
-              },
-              {
-                items: {
-                  type: "string",
-                  const: "*"
-                }
-              }
-            ]
-          },
-          active: {
-            title: "Active",
-            type: "boolean",
-            default: true,
-            description: "Determines if notifications are sent when the webhook is triggered. Default: `true`"
-          },
-          contentType: {
-            title: "Content Type",
-            type: "string",
-            enum: ["form", "json"],
-            default: "form",
-            description: "The media type used to serialize the payloads. The default is `form`"
-          },
-          insecureSsl: {
-            title: "Insecure SSL",
-            type: "boolean",
-            default: false,
-            description: "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`"
-          },
-          token: {
-            title: "Authentication Token",
-            type: "string",
-            description: "The `GITHUB_TOKEN` to use for authorization to GitHub"
-          }
-        }
+        repoUrl: (z) => z.string({
+          description: "Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username"
+        }),
+        webhookUrl: (z) => z.string({
+          description: "The URL to which the payloads will be delivered"
+        }),
+        webhookSecret: (z) => z.string({
+          description: "Webhook secret value. The default can be provided internally in action creation"
+        }).optional(),
+        events: (z) => z.union([
+          z.array(z.enum(eventNames), {
+            description: "Determines what events the hook is triggered for. Default: `[push]`"
+          }),
+          z.array(z.literal("*"), {
+            description: 'Determines what events the hook is triggered for. Use "*" for all events. Default: `[push]`'
+          })
+        ]).default(["push"]).optional(),
+        active: (z) => z.boolean({
+          description: "Determines if notifications are sent when the webhook is triggered. Default: `true`"
+        }).default(true).optional(),
+        contentType: (z) => z.enum(["form", "json"], {
+          description: "The media type used to serialize the payloads. The default is `form`"
+        }).default("form").optional(),
+        insecureSsl: (z) => z.boolean({
+          description: "Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`"
+        }).default(false).optional(),
+        token: (z) => z.string({
+          description: "The `GITHUB_TOKEN` to use for authorization to GitHub"
+        }).optional()
       }
     },
     async handler(ctx) {

package/dist/actions/githubWebhook.cjs.js.map

@@ -1 +1 @@
-{"version":3,"file":"githubWebhook.cjs.js","sources":["../../src/actions/githubWebhook.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { emitterEventNames } from '@octokit/webhooks';\nimport { assertError, InputError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubWebhook.examples';\n\n/**\n * Creates new action that creates a webhook for a repository on GitHub.\n * @public\n */\nexport function createGithubWebhookAction(options: {\n  integrations: ScmIntegrationRegistry;\n  defaultWebhookSecret?: string;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, defaultWebhookSecret, githubCredentialsProvider } =\n    options;\n\n  const eventNames = emitterEventNames.filter(event => !event.includes('.'));\n\n  return createTemplateAction<{\n    repoUrl: string;\n    webhookUrl: string;\n    webhookSecret?: string;\n    events?: string[];\n    active?: boolean;\n    contentType?: 'form' | 'json';\n    insecureSsl?: boolean;\n    token?: string;\n  }>({\n    id: 'github:webhook',\n    description: 'Creates webhook for a repository on GitHub.',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        type: 'object',\n        required: ['repoUrl', 'webhookUrl'],\n        properties: {\n          repoUrl: {\n            title: 'Repository Location',\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n            type: 'string',\n          },\n          webhookUrl: {\n            title: 'Webhook URL',\n            description: 'The URL to which the payloads will be delivered',\n            type: 'string',\n          },\n          webhookSecret: {\n            title: 'Webhook Secret',\n            description:\n              'Webhook secret value. The default can be provided internally in action creation',\n            type: 'string',\n          },\n          events: {\n            title: 'Triggering Events',\n            description:\n              'Determines what events the hook is triggered for. Default: `[push]`',\n            type: 'array',\n            default: ['push'],\n            oneOf: [\n              {\n                items: {\n                  type: 'string',\n                  enum: eventNames,\n                },\n              },\n              {\n                items: {\n                  type: 'string',\n                  const: '*',\n                },\n              },\n            ],\n          },\n          active: {\n            title: 'Active',\n            type: 'boolean',\n            default: true,\n            description:\n              'Determines if notifications are sent when the webhook is triggered. Default: `true`',\n          },\n          contentType: {\n            title: 'Content Type',\n            type: 'string',\n            enum: ['form', 'json'],\n            default: 'form',\n            description:\n              'The media type used to serialize the payloads. The default is `form`',\n          },\n          insecureSsl: {\n            title: 'Insecure SSL',\n            type: 'boolean',\n            default: false,\n            description:\n              'Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`',\n          },\n          token: {\n            title: 'Authentication Token',\n            type: 'string',\n            description:\n              'The `GITHUB_TOKEN` to use for authorization to GitHub',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        webhookUrl,\n        webhookSecret = defaultWebhookSecret,\n        events = ['push'],\n        active = true,\n        contentType = 'form',\n        insecureSsl = false,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(`Creating webhook ${webhookUrl} for repo ${repoUrl}`);\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const insecure_ssl = insecureSsl ? '1' : '0';\n\n        await ctx.checkpoint({\n          key: `create.webhhook.${owner}.${repo}.${webhookUrl}`,\n          fn: async () => {\n            await client.rest.repos.createWebhook({\n              owner,\n              repo,\n              config: {\n                url: webhookUrl,\n                content_type: contentType,\n                secret: webhookSecret,\n                insecure_ssl,\n              },\n              events,\n              active,\n            });\n          },\n        });\n\n        ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);\n      } catch (e) {\n        assertError(e);\n        ctx.logger.warn(\n          `Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${e.message}`,\n        );\n      }\n    },\n  });\n}\n"],"names":["emitterEventNames","createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","assertError"],"mappings":";;;;;;;;;AAkCO,SAAS,0BAA0B,OAIvC,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,oBAAsB,EAAA,yBAAA,EAC1C,GAAA,OAAA;AAEF,EAAM,MAAA,UAAA,GAAaA,2BAAkB,MAAO,CAAA,CAAA,KAAA,KAAS,CAAC,KAAM,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA;AAEzE,EAAA,OAAOC,yCASJ,CAAA;AAAA,IACD,EAAI,EAAA,gBAAA;AAAA,IACJ,WAAa,EAAA,6CAAA;AAAA,cACbC,+BAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,IAAM,EAAA,QAAA;AAAA,QACN,QAAA,EAAU,CAAC,SAAA,EAAW,YAAY,CAAA;AAAA,QAClC,UAAY,EAAA;AAAA,UACV,OAAS,EAAA;AAAA,YACP,KAAO,EAAA,qBAAA;AAAA,YACP,WACE,EAAA,kJAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,UAAY,EAAA;AAAA,YACV,KAAO,EAAA,aAAA;AAAA,YACP,WAAa,EAAA,iDAAA;AAAA,YACb,IAAM,EAAA;AAAA,WACR;AAAA,UACA,aAAe,EAAA;AAAA,YACb,KAAO,EAAA,gBAAA;AAAA,YACP,WACE,EAAA,iFAAA;AAAA,YACF,IAAM,EAAA;AAAA,WACR;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,mBAAA;AAAA,YACP,WACE,EAAA,qEAAA;AAAA,YACF,IAAM,EAAA,OAAA;AAAA,YACN,OAAA,EAAS,CAAC,MAAM,CAAA;AAAA,YAChB,KAAO,EAAA;AAAA,cACL;AAAA,gBACE,KAAO,EAAA;AAAA,kBACL,IAAM,EAAA,QAAA;AAAA,kBACN,IAAM,EAAA;AAAA;AACR,eACF;AAAA,cACA;AAAA,gBACE,KAAO,EAAA;AAAA,kBACL,IAAM,EAAA,QAAA;AAAA,kBACN,KAAO,EAAA;AAAA;AACT;AACF;AACF,WACF;AAAA,UACA,MAAQ,EAAA;AAAA,YACN,KAAO,EAAA,QAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,OAAS,EAAA,IAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,IAAA,EAAM,CAAC,MAAA,EAAQ,MAAM,CAAA;AAAA,YACrB,OAAS,EAAA,MAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,WAAa,EAAA;AAAA,YACX,KAAO,EAAA,cAAA;AAAA,YACP,IAAM,EAAA,SAAA;AAAA,YACN,OAAS,EAAA,KAAA;AAAA,YACT,WACE,EAAA;AAAA,WACJ;AAAA,UACA,KAAO,EAAA;AAAA,YACL,KAAO,EAAA,sBAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,YACN,WACE,EAAA;AAAA;AACJ;AACF;AACF,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAgB,GAAA,oBAAA;AAAA,QAChB,MAAA,GAAS,CAAC,MAAM,CAAA;AAAA,QAChB,MAAS,GAAA,IAAA;AAAA,QACT,WAAc,GAAA,MAAA;AAAA,QACd,WAAc,GAAA,KAAA;AAAA,QACd,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,iBAAA,EAAoB,UAAU,CAAA,UAAA,EAAa,OAAO,CAAE,CAAA,CAAA;AACpE,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAO,EAAA;AAAA,OACR,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAQ,CAAA;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAI,CAAA;AAAA,OACV,CAAA;AAGD,MAAA,IAAI,IAAI,QAAU,EAAA;AAChB,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAkB,gBAAA,CAAA,CAAA;AAClC,QAAA;AAAA;AAGF,MAAI,IAAA;AACF,QAAM,MAAA,YAAA,GAAe,cAAc,GAAM,GAAA,GAAA;AAEzC,QAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACnB,KAAK,CAAmB,gBAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UACnD,IAAI,YAAY;AACd,YAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,cACpC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAQ,EAAA;AAAA,gBACN,GAAK,EAAA,UAAA;AAAA,gBACL,YAAc,EAAA,WAAA;AAAA,gBACd,MAAQ,EAAA,aAAA;AAAA,gBACR;AAAA,eACF;AAAA,cACA,MAAA;AAAA,cACA;AAAA,aACD,CAAA;AAAA;AACH,SACD,CAAA;AAED,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAY,SAAA,EAAA,UAAU,CAAwB,sBAAA,CAAA,CAAA;AAAA,eACvD,CAAG,EAAA;AACV,QAAAC,kBAAA,CAAY,CAAC,CAAA;AACb,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,2BAA2B,UAAU,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,EAAE,OAAO,CAAA;AAAA,SACzE;AAAA;AACF;AACF,GACD,CAAA;AACH;;;;"}
+{"version":3,"file":"githubWebhook.cjs.js","sources":["../../src/actions/githubWebhook.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport {\n  GithubCredentialsProvider,\n  ScmIntegrationRegistry,\n} from '@backstage/integration';\nimport {\n  createTemplateAction,\n  parseRepoUrl,\n} from '@backstage/plugin-scaffolder-node';\nimport { emitterEventNames } from '@octokit/webhooks';\nimport { assertError, InputError } from '@backstage/errors';\nimport { Octokit } from 'octokit';\nimport { getOctokitOptions } from '../util';\nimport { examples } from './githubWebhook.examples';\n\n/**\n * Creates new action that creates a webhook for a repository on GitHub.\n * @public\n */\nexport function createGithubWebhookAction(options: {\n  integrations: ScmIntegrationRegistry;\n  defaultWebhookSecret?: string;\n  githubCredentialsProvider?: GithubCredentialsProvider;\n}) {\n  const { integrations, defaultWebhookSecret, githubCredentialsProvider } =\n    options;\n\n  const eventNames = emitterEventNames.filter(event => !event.includes('.'));\n\n  return createTemplateAction({\n    id: 'github:webhook',\n    description: 'Creates webhook for a repository on GitHub.',\n    examples,\n    supportsDryRun: true,\n    schema: {\n      input: {\n        repoUrl: z =>\n          z.string({\n            description:\n              'Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username',\n          }),\n        webhookUrl: z =>\n          z.string({\n            description: 'The URL to which the payloads will be delivered',\n          }),\n        webhookSecret: z =>\n          z\n            .string({\n              description:\n                'Webhook secret value. The default can be provided internally in action creation',\n            })\n            .optional(),\n        events: z =>\n          z\n            .union([\n              z.array(z.enum(eventNames as [string, ...string[]]), {\n                description:\n                  'Determines what events the hook is triggered for. Default: `[push]`',\n              }),\n              z.array(z.literal('*'), {\n                description:\n                  'Determines what events the hook is triggered for. Use \"*\" for all events. Default: `[push]`',\n              }),\n            ])\n            .default(['push'])\n            .optional(),\n        active: z =>\n          z\n            .boolean({\n              description:\n                'Determines if notifications are sent when the webhook is triggered. Default: `true`',\n            })\n            .default(true)\n            .optional(),\n        contentType: z =>\n          z\n            .enum(['form', 'json'], {\n              description:\n                'The media type used to serialize the payloads. The default is `form`',\n            })\n            .default('form')\n            .optional(),\n        insecureSsl: z =>\n          z\n            .boolean({\n              description:\n                'Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Default `false`',\n            })\n            .default(false)\n            .optional(),\n        token: z =>\n          z\n            .string({\n              description:\n                'The `GITHUB_TOKEN` to use for authorization to GitHub',\n            })\n            .optional(),\n      },\n    },\n    async handler(ctx) {\n      const {\n        repoUrl,\n        webhookUrl,\n        webhookSecret = defaultWebhookSecret,\n        events = ['push'],\n        active = true,\n        contentType = 'form',\n        insecureSsl = false,\n        token: providedToken,\n      } = ctx.input;\n\n      ctx.logger.info(`Creating webhook ${webhookUrl} for repo ${repoUrl}`);\n      const { host, owner, repo } = parseRepoUrl(repoUrl, integrations);\n\n      if (!owner) {\n        throw new InputError('Invalid repository owner provided in repoUrl');\n      }\n\n      const octokitOptions = await getOctokitOptions({\n        integrations,\n        credentialsProvider: githubCredentialsProvider,\n        host,\n        owner,\n        repo,\n        token: providedToken,\n      });\n      const client = new Octokit({\n        ...octokitOptions,\n        log: ctx.logger,\n      });\n\n      // If this is a dry run, log and return\n      if (ctx.isDryRun) {\n        ctx.logger.info(`Dry run complete`);\n        return;\n      }\n\n      try {\n        const insecure_ssl = insecureSsl ? '1' : '0';\n\n        await ctx.checkpoint({\n          key: `create.webhhook.${owner}.${repo}.${webhookUrl}`,\n          fn: async () => {\n            await client.rest.repos.createWebhook({\n              owner,\n              repo,\n              config: {\n                url: webhookUrl,\n                content_type: contentType,\n                secret: webhookSecret,\n                insecure_ssl,\n              },\n              events,\n              active,\n            });\n          },\n        });\n\n        ctx.logger.info(`Webhook '${webhookUrl}' created successfully`);\n      } catch (e) {\n        assertError(e);\n        ctx.logger.warn(\n          `Failed: create webhook '${webhookUrl}' on repo: '${repo}', ${e.message}`,\n        );\n      }\n    },\n  });\n}\n"],"names":["emitterEventNames","createTemplateAction","examples","parseRepoUrl","InputError","getOctokitOptions","Octokit","assertError"],"mappings":";;;;;;;;;AAkCO,SAAS,0BAA0B,OAIvC,EAAA;AACD,EAAA,MAAM,EAAE,YAAA,EAAc,oBAAsB,EAAA,yBAAA,EAC1C,GAAA,OAAA;AAEF,EAAM,MAAA,UAAA,GAAaA,2BAAkB,MAAO,CAAA,CAAA,KAAA,KAAS,CAAC,KAAM,CAAA,QAAA,CAAS,GAAG,CAAC,CAAA;AAEzE,EAAA,OAAOC,yCAAqB,CAAA;AAAA,IAC1B,EAAI,EAAA,gBAAA;AAAA,IACJ,WAAa,EAAA,6CAAA;AAAA,cACbC,+BAAA;AAAA,IACA,cAAgB,EAAA,IAAA;AAAA,IAChB,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,OAAA,EAAS,CACP,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,CAAA;AAAA,QACH,UAAA,EAAY,CACV,CAAA,KAAA,CAAA,CAAE,MAAO,CAAA;AAAA,UACP,WAAa,EAAA;AAAA,SACd,CAAA;AAAA,QACH,aAAA,EAAe,CACb,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WACE,EAAA;AAAA,SACH,EACA,QAAS,EAAA;AAAA,QACd,MAAA,EAAQ,CACN,CAAA,KAAA,CAAA,CACG,KAAM,CAAA;AAAA,UACL,CAAE,CAAA,KAAA,CAAM,CAAE,CAAA,IAAA,CAAK,UAAmC,CAAG,EAAA;AAAA,YACnD,WACE,EAAA;AAAA,WACH,CAAA;AAAA,UACD,CAAE,CAAA,KAAA,CAAM,CAAE,CAAA,OAAA,CAAQ,GAAG,CAAG,EAAA;AAAA,YACtB,WACE,EAAA;AAAA,WACH;AAAA,SACF,CACA,CAAA,OAAA,CAAQ,CAAC,MAAM,CAAC,EAChB,QAAS,EAAA;AAAA,QACd,MAAA,EAAQ,CACN,CAAA,KAAA,CAAA,CACG,OAAQ,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,CAAA,CACA,OAAQ,CAAA,IAAI,EACZ,QAAS,EAAA;AAAA,QACd,aAAa,CACX,CAAA,KAAA,CAAA,CACG,KAAK,CAAC,MAAA,EAAQ,MAAM,CAAG,EAAA;AAAA,UACtB,WACE,EAAA;AAAA,SACH,CAAA,CACA,OAAQ,CAAA,MAAM,EACd,QAAS,EAAA;AAAA,QACd,WAAA,EAAa,CACX,CAAA,KAAA,CAAA,CACG,OAAQ,CAAA;AAAA,UACP,WACE,EAAA;AAAA,SACH,CAAA,CACA,OAAQ,CAAA,KAAK,EACb,QAAS,EAAA;AAAA,QACd,KAAA,EAAO,CACL,CAAA,KAAA,CAAA,CACG,MAAO,CAAA;AAAA,UACN,WACE,EAAA;AAAA,SACH,EACA,QAAS;AAAA;AAChB,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAM,MAAA;AAAA,QACJ,OAAA;AAAA,QACA,UAAA;AAAA,QACA,aAAgB,GAAA,oBAAA;AAAA,QAChB,MAAA,GAAS,CAAC,MAAM,CAAA;AAAA,QAChB,MAAS,GAAA,IAAA;AAAA,QACT,WAAc,GAAA,MAAA;AAAA,QACd,WAAc,GAAA,KAAA;AAAA,QACd,KAAO,EAAA;AAAA,UACL,GAAI,CAAA,KAAA;AAER,MAAA,GAAA,CAAI,OAAO,IAAK,CAAA,CAAA,iBAAA,EAAoB,UAAU,CAAA,UAAA,EAAa,OAAO,CAAE,CAAA,CAAA;AACpE,MAAA,MAAM,EAAE,IAAM,EAAA,KAAA,EAAO,MAAS,GAAAC,iCAAA,CAAa,SAAS,YAAY,CAAA;AAEhE,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAIC,kBAAW,8CAA8C,CAAA;AAAA;AAGrE,MAAM,MAAA,cAAA,GAAiB,MAAMC,sBAAkB,CAAA;AAAA,QAC7C,YAAA;AAAA,QACA,mBAAqB,EAAA,yBAAA;AAAA,QACrB,IAAA;AAAA,QACA,KAAA;AAAA,QACA,IAAA;AAAA,QACA,KAAO,EAAA;AAAA,OACR,CAAA;AACD,MAAM,MAAA,MAAA,GAAS,IAAIC,eAAQ,CAAA;AAAA,QACzB,GAAG,cAAA;AAAA,QACH,KAAK,GAAI,CAAA;AAAA,OACV,CAAA;AAGD,MAAA,IAAI,IAAI,QAAU,EAAA;AAChB,QAAI,GAAA,CAAA,MAAA,CAAO,KAAK,CAAkB,gBAAA,CAAA,CAAA;AAClC,QAAA;AAAA;AAGF,MAAI,IAAA;AACF,QAAM,MAAA,YAAA,GAAe,cAAc,GAAM,GAAA,GAAA;AAEzC,QAAA,MAAM,IAAI,UAAW,CAAA;AAAA,UACnB,KAAK,CAAmB,gBAAA,EAAA,KAAK,CAAI,CAAA,EAAA,IAAI,IAAI,UAAU,CAAA,CAAA;AAAA,UACnD,IAAI,YAAY;AACd,YAAM,MAAA,MAAA,CAAO,IAAK,CAAA,KAAA,CAAM,aAAc,CAAA;AAAA,cACpC,KAAA;AAAA,cACA,IAAA;AAAA,cACA,MAAQ,EAAA;AAAA,gBACN,GAAK,EAAA,UAAA;AAAA,gBACL,YAAc,EAAA,WAAA;AAAA,gBACd,MAAQ,EAAA,aAAA;AAAA,gBACR;AAAA,eACF;AAAA,cACA,MAAA;AAAA,cACA;AAAA,aACD,CAAA;AAAA;AACH,SACD,CAAA;AAED,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA,CAAK,CAAY,SAAA,EAAA,UAAU,CAAwB,sBAAA,CAAA,CAAA;AAAA,eACvD,CAAG,EAAA;AACV,QAAAC,kBAAA,CAAY,CAAC,CAAA;AACb,QAAA,GAAA,CAAI,MAAO,CAAA,IAAA;AAAA,UACT,2BAA2B,UAAU,CAAA,YAAA,EAAe,IAAI,CAAA,GAAA,EAAM,EAAE,OAAO,CAAA;AAAA,SACzE;AAAA;AACF;AACF,GACD,CAAA;AACH;;;;"}

package/dist/actions/inputProperties.cjs.js

@@ -1,315 +1,178 @@
 'use strict';
 
-const repoUrl = {
-  title: "Repository Location",
-  description: "Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username",
-  type: "string"
-};
-const description = {
-  title: "Repository Description",
-  type: "string"
-};
-const homepage = {
-  title: "Repository Homepage",
-  type: "string"
-};
-const access = {
-  title: "Repository Access",
-  description: "Sets an admin collaborator on the repository. Can either be a user reference different from `owner` in `repoUrl` or team reference, eg. `org/team-name`",
-  type: "string"
-};
-const requireCodeOwnerReviews = {
-  title: "Require CODEOWNER Reviews?",
-  description: "Require an approved review in PR including files with a designated Code Owner",
-  type: "boolean"
-};
-const dismissStaleReviews = {
-  title: "Dismiss Stale Reviews",
-  description: "New reviewable commits pushed to a matching branch will dismiss pull request review approvals.",
-  type: "boolean"
-};
-const requiredStatusCheckContexts = {
-  title: "Required Status Check Contexts",
-  description: "The list of status checks to require in order to merge into this branch",
-  type: "array",
-  items: {
-    type: "string"
-  }
-};
-const requireBranchesToBeUpToDate = {
-  title: "Require Branches To Be Up To Date?",
-  description: "Require branches to be up to date before merging. The default value is `true`",
-  type: "boolean",
-  default: true
-};
-const requiredConversationResolution = {
-  title: "Required Conversation Resolution",
-  description: "Requires all conversations on code to be resolved before a pull request can be merged into this branch",
-  type: "boolean"
-};
-const requireLastPushApproval = {
-  title: "Require last push approval",
-  type: "boolean",
-  default: false,
+const repoUrl = (z) => z.string({
+  description: "Accepts the format `github.com?repo=reponame&owner=owner` where `reponame` is the new repository name and `owner` is an organization or username"
+});
+const description = (z) => z.string({
+  description: "Repository Description"
+}).optional();
+const homepage = (z) => z.string({
+  description: "Repository Homepage"
+}).optional();
+const access = (z) => z.string({
+  description: "Sets an admin collaborator on the repository. Can either be a user reference different from `owner` in `repoUrl` or team reference, eg. `org/team-name`"
+}).optional();
+const requireCodeOwnerReviews = (z) => z.boolean({
+  description: "Require an approved review in PR including files with a designated Code Owner"
+}).optional();
+const dismissStaleReviews = (z) => z.boolean({
+  description: "New reviewable commits pushed to a matching branch will dismiss pull request review approvals."
+}).optional();
+const requiredStatusCheckContexts = (z) => z.array(z.string(), {
+  description: "The list of status checks to require in order to merge into this branch"
+}).optional();
+const requireBranchesToBeUpToDate = (z) => z.boolean({
+  description: "Require branches to be up to date before merging. The default value is `true`"
+}).default(true).optional();
+const requiredConversationResolution = (z) => z.boolean({
+  description: "Requires all conversations on code to be resolved before a pull request can be merged into this branch"
+}).optional();
+const requireLastPushApproval = (z) => z.boolean({
   description: "Whether the most recent push to a PR must be approved by someone other than the person who pushed it. The default value is `false`"
-};
-const repoVisibility = {
-  title: "Repository Visibility",
-  type: "string",
-  enum: ["private", "public", "internal"]
-};
-const deleteBranchOnMerge = {
-  title: "Delete Branch On Merge",
-  type: "boolean",
-  default: false,
+}).default(false).optional();
+const repoVisibility = (z) => z.enum(["private", "public", "internal"], {
+  description: "Repository Visibility"
+}).optional();
+const deleteBranchOnMerge = (z) => z.boolean({
   description: "Delete the branch after merging the PR. The default value is `false`"
-};
-const gitAuthorName = {
-  title: "Default Author Name",
-  type: "string",
-  default: "Scaffolder",
+}).default(false).optional();
+const gitAuthorName = (z) => z.string({
   description: "Sets the default author name for the commit. The default value is `Scaffolder`"
-};
-const gitAuthorEmail = {
-  title: "Default Author Email",
-  type: "string",
+}).default("Scaffolder").optional();
+const gitAuthorEmail = (z) => z.string({
   description: `Sets the default author email for the commit.`
-};
-const allowMergeCommit = {
-  title: "Allow Merge Commits",
-  type: "boolean",
-  default: true,
+}).optional();
+const allowMergeCommit = (z) => z.boolean({
   description: "Allow merge commits. The default value is `true`"
-};
-const allowSquashMerge = {
-  title: "Allow Squash Merges",
-  type: "boolean",
-  default: true,
+}).default(true).optional();
+const allowSquashMerge = (z) => z.boolean({
   description: "Allow squash merges. The default value is `true`"
-};
-const allowUpdateBranch = {
-  title: "Allow Update Branch",
-  type: "boolean",
-  default: false,
+}).default(true).optional();
+const allowUpdateBranch = (z) => z.boolean({
   description: "Allow branch to be updated. The default value is `false`"
-};
-const squashMergeCommitTitle = {
-  title: "Default squash merge commit title",
-  enum: ["PR_TITLE", "COMMIT_OR_PR_TITLE"],
-  type: "string",
-  default: "COMMIT_OR_PR_TITLE",
+}).default(false).optional();
+const squashMergeCommitTitle = (z) => z.enum(["PR_TITLE", "COMMIT_OR_PR_TITLE"], {
   description: "Sets the default value for a squash merge commit title. The default value is `COMMIT_OR_PR_TITLE`"
-};
-const squashMergeCommitMessage = {
-  title: "Default squash merge commit message",
-  enum: ["PR_BODY", "COMMIT_MESSAGES", "BLANK"],
-  type: "string",
-  default: "COMMIT_MESSAGES",
+}).default("COMMIT_OR_PR_TITLE").optional();
+const squashMergeCommitMessage = (z) => z.enum(["PR_BODY", "COMMIT_MESSAGES", "BLANK"], {
   description: "Sets the default value for a squash merge commit message. The default value is `COMMIT_MESSAGES`"
-};
-const allowRebaseMerge = {
-  title: "Allow Rebase Merges",
-  type: "boolean",
-  default: true,
+}).default("COMMIT_MESSAGES").optional();
+const allowRebaseMerge = (z) => z.boolean({
   description: "Allow rebase merges. The default value is `true`"
-};
-const allowAutoMerge = {
-  title: "Allow Auto Merges",
-  type: "boolean",
-  default: false,
+}).default(true).optional();
+const allowAutoMerge = (z) => z.boolean({
   description: "Allow individual PRs to merge automatically when all merge requirements are met. The default value is `false`"
-};
-const collaborators = {
-  title: "Collaborators",
-  description: "Provide additional users or teams with permissions",
-  type: "array",
-  items: {
-    type: "object",
-    additionalProperties: false,
-    required: ["access"],
-    properties: {
-      access: {
-        type: "string",
+}).default(false).optional();
+const collaborators = (z) => z.array(
+  z.union([
+    z.object({
+      access: z.string({
         description: "The type of access for the user"
-      },
-      user: {
-        type: "string",
+      }),
+      user: z.string({
         description: "The name of the user that will be added as a collaborator"
-      },
-      team: {
-        type: "string",
+      })
+    }),
+    z.object({
+      access: z.string({
+        description: "The type of access for the team"
+      }),
+      team: z.string({
         description: "The name of the team that will be added as a collaborator"
-      }
-    },
-    oneOf: [{ required: ["user"] }, { required: ["team"] }]
+      })
+    })
+  ]),
+  {
+    description: "Provide additional users or teams with permissions"
   }
-};
-const hasProjects = {
-  title: "Enable projects",
-  type: "boolean",
+).optional();
+const hasProjects = (z) => z.boolean({
   description: "Enable projects for the repository. The default value is `true` unless the organization has disabled repository projects"
-};
-const hasWiki = {
-  title: "Enable the wiki",
-  type: "boolean",
-  default: true,
+}).optional();
+const hasWiki = (z) => z.boolean({
   description: "Enable the wiki for the repository. The default value is `true`"
-};
-const hasIssues = {
-  title: "Enable issues",
-  type: "boolean",
-  default: true,
+}).default(true).optional();
+const hasIssues = (z) => z.boolean({
   description: "Enable issues for the repository. The default value is `true`"
-};
-const token = {
-  title: "Authentication Token",
-  type: "string",
+}).default(true).optional();
+const token = (z) => z.string({
   description: "The token to use for authorization to GitHub"
-};
-const topics = {
-  title: "Topics",
-  type: "array",
-  items: {
-    type: "string"
-  }
-};
-const defaultBranch = {
-  title: "Default Branch",
-  type: "string",
-  default: "master",
-  description: "Sets the default branch on the repository. The default value is `master`"
-};
-const protectDefaultBranch = {
-  title: "Protect Default Branch",
-  type: "boolean",
-  default: true,
+}).optional();
+const topics = (z) => z.array(z.string(), {
+  description: "Adds topics to the repository"
+}).optional();
+const defaultBranch = (z) => z.string({
+  description: `Sets the default branch on the repository. The default value is 'master'`
+}).default("master").optional();
+const protectDefaultBranch = (z) => z.boolean({
   description: "Protect the default branch after creating the repository. The default value is `true`"
-};
-const protectEnforceAdmins = {
-  title: "Enforce Admins On Protected Branches",
-  type: "boolean",
-  default: true,
+}).default(true).optional();
+const protectEnforceAdmins = (z) => z.boolean({
   description: "Enforce admins to adhere to default branch protection. The default value is `true`"
-};
-const bypassPullRequestAllowances = {
-  title: "Bypass pull request requirements",
-  description: "Allow specific users, teams, or apps to bypass pull request requirements.",
-  type: "object",
-  additionalProperties: false,
-  properties: {
-    apps: {
-      type: "array",
-      items: {
-        type: "string"
-      }
-    },
-    users: {
-      type: "array",
-      items: {
-        type: "string"
-      }
-    },
-    teams: {
-      type: "array",
-      items: {
-        type: "string"
-      }
-    }
+}).default(true).optional();
+const bypassPullRequestAllowances = (z) => z.object(
+  {
+    apps: z.array(z.string()).optional(),
+    users: z.array(z.string()).optional(),
+    teams: z.array(z.string()).optional()
+  },
+  {
+    description: "Allow specific users, teams, or apps to bypass pull request requirements."
   }
-};
-const gitCommitMessage = {
-  title: "Git Commit Message",
-  type: "string",
-  default: "initial commit",
+).optional();
+const gitCommitMessage = (z) => z.string({
   description: "Sets the commit message on the repository. The default value is `initial commit`"
-};
-const sourcePath = {
-  title: "Source Path",
-  description: "Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository.",
-  type: "string"
-};
-const requiredApprovingReviewCount = {
-  title: "Required approving review count",
-  type: "number",
+}).default("initial commit").optional();
+const sourcePath = (z) => z.string({
+  description: "Path within the workspace that will be used as the repository root. If omitted, the entire workspace will be published as the repository."
+}).optional();
+const requiredApprovingReviewCount = (z) => z.number({
   description: "Specify the number of reviewers required to approve pull requests. Use a number between `1` and `6` or `0` to not require reviewers. Defaults to `1`."
-};
-const restrictions = {
-  title: "Restrict who can push to the protected branch",
-  description: "Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories.",
-  type: "object",
-  additionalProperties: false,
-  properties: {
-    apps: {
-      type: "array",
-      items: {
-        type: "string"
-      }
-    },
-    users: {
-      type: "array",
-      items: {
-        type: "string"
-      }
-    },
-    teams: {
-      type: "array",
-      items: {
-        type: "string"
-      }
-    }
+}).optional();
+const restrictions = (z) => z.object(
+  {
+    apps: z.array(z.string()).optional(),
+    users: z.array(z.string()),
+    teams: z.array(z.string())
+  },
+  {
+    description: "Restrict who can push to the protected branch. User, app, and team restrictions are only available for organization-owned repositories."
   }
-};
-const requiredCommitSigning = {
-  title: "Require commit signing",
-  type: "boolean",
+).optional();
+const requiredCommitSigning = (z) => z.boolean({
   description: `Require commit signing so that you must sign commits on this branch.`
-};
-const requiredLinearHistory = {
-  title: "Require linear history",
-  type: "boolean",
+}).optional();
+const requiredLinearHistory = (z) => z.boolean({
   description: `Prevent merge commits from being pushed to matching branches.`
-};
-const repoVariables = {
-  title: "Repository Variables",
-  description: `Variables attached to the repository`,
-  type: "object"
-};
-const secrets = {
-  title: "Repository Secrets",
-  description: `Secrets attached to the repository`,
-  type: "object"
-};
-const oidcCustomization = {
-  title: "Repository OIDC customization template",
-  description: `OIDC customization template attached to the repository.`,
-  type: "object",
-  additionalProperties: false,
-  properties: {
-    useDefault: {
-      title: "Use Default",
-      type: "boolean",
-      description: `Whether to use the default OIDC template or not.`
-    },
-    includeClaimKeys: {
-      title: "Include claim keys",
-      type: "array",
-      items: {
-        type: "string"
-      },
+}).optional();
+const repoVariables = (z) => z.record(z.string(), {
+  description: "Variables attached to the repository"
+}).optional();
+const secrets = (z) => z.record(z.string(), {
+  description: "Secrets attached to the repository"
+}).optional();
+const oidcCustomization = (z) => z.object(
+  {
+    useDefault: z.boolean({
+      description: `Whether to use the default template or not. If true, includeClaimKeys must not be set.`
+    }).default(true),
+    includeClaimKeys: z.array(z.string(), {
       description: `Array of unique strings. Each claim key can only contain alphanumeric characters and underscores.`
-    }
+    }).optional()
+  },
+  {
+    description: `OIDC customization template attached to the repository.`
   }
-};
-const customProperties = {
-  title: "Custom Repository Properties",
-  description: "Custom properties to be added to the repository (note, this only works for organization repositories)",
-  type: "object"
-};
-const subscribe = {
-  title: "Subscribe to repository",
-  description: `Subscribe to the repository. The default value is 'false'`,
-  type: "boolean"
-};
+).optional();
+const customProperties = (z) => z.record(z.string(), {
+  description: "Custom properties to be added to the repository (note, this only works for organization repositories)"
+}).optional();
+const subscribe = (z) => z.boolean({
+  description: `Subscribe to the repository. The default value is 'false'`
+}).optional();
+const branch = (z) => z.string({
+  description: `The branch to protect. Defaults to the repository's default branch`
+}).optional();
 
 exports.access = access;
 exports.allowAutoMerge = allowAutoMerge;
@@ -317,6 +180,7 @@ exports.allowMergeCommit = allowMergeCommit;
 exports.allowRebaseMerge = allowRebaseMerge;
 exports.allowSquashMerge = allowSquashMerge;
 exports.allowUpdateBranch = allowUpdateBranch;
+exports.branch = branch;
 exports.bypassPullRequestAllowances = bypassPullRequestAllowances;
 exports.collaborators = collaborators;
 exports.customProperties = customProperties;