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

package/dist/index.d.ts

@@ -22,9 +22,9 @@ declare function createGithubActionsDispatchAction(options: {
     branchOrTagName: string;
     workflowInputs?: {
         [key: string]: string;
-    } | undefined;
-    token?: string | undefined;
-}, _backstage_types.JsonObject>;
+    };
+    token?: string;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Adds labels to a pull request or issue on GitHub
@@ -37,8 +37,8 @@ declare function createGithubIssuesLabelAction(options: {
     repoUrl: string;
     number: number;
     labels: string[];
-    token?: string | undefined;
-}, _backstage_types.JsonObject>;
+    token?: string;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates a new action that initializes a git repository
@@ -50,35 +50,35 @@ declare function createGithubRepoCreateAction(options: {
     githubCredentialsProvider?: GithubCredentialsProvider;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
-    description?: string | undefined;
-    homepage?: string | undefined;
-    access?: string | undefined;
-    deleteBranchOnMerge?: boolean | undefined;
-    gitAuthorName?: string | undefined;
-    gitAuthorEmail?: string | undefined;
-    allowRebaseMerge?: boolean | undefined;
-    allowSquashMerge?: boolean | undefined;
-    squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE" | undefined;
-    squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK" | undefined;
-    allowMergeCommit?: boolean | undefined;
-    allowAutoMerge?: boolean | undefined;
-    requireCodeOwnerReviews?: boolean | undefined;
+    description?: string;
+    homepage?: string;
+    access?: string;
+    deleteBranchOnMerge?: boolean;
+    gitAuthorName?: string;
+    gitAuthorEmail?: string;
+    allowRebaseMerge?: boolean;
+    allowSquashMerge?: boolean;
+    squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+    squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+    allowMergeCommit?: boolean;
+    allowAutoMerge?: boolean;
+    requireCodeOwnerReviews?: boolean;
     bypassPullRequestAllowances?: {
-        users?: string[] | undefined;
-        teams?: string[] | undefined;
-        apps?: string[] | undefined;
-    } | undefined;
-    requiredApprovingReviewCount?: number | undefined;
+        users?: string[];
+        teams?: string[];
+        apps?: string[];
+    };
+    requiredApprovingReviewCount?: number;
     restrictions?: {
         users: string[];
         teams: string[];
-        apps?: string[] | undefined;
-    } | undefined;
-    requiredStatusCheckContexts?: string[] | undefined;
-    requireBranchesToBeUpToDate?: boolean | undefined;
-    requiredConversationResolution?: boolean | undefined;
-    repoVisibility?: "internal" | "private" | "public" | undefined;
-    collaborators?: ({
+        apps?: string[];
+    };
+    requiredStatusCheckContexts?: string[];
+    requireBranchesToBeUpToDate?: boolean;
+    requiredConversationResolution?: boolean;
+    repoVisibility?: "private" | "internal" | "public";
+    collaborators?: Array<{
         user: string;
         access: string;
     } | {
@@ -87,30 +87,30 @@ declare function createGithubRepoCreateAction(options: {
     } | {
         /** @deprecated This field is deprecated in favor of team */
         username: string;
-        access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
-    })[] | undefined;
-    hasProjects?: boolean | undefined;
-    hasWiki?: boolean | undefined;
-    hasIssues?: boolean | undefined;
-    token?: string | undefined;
-    topics?: string[] | undefined;
+        access: "pull" | "push" | "admin" | "maintain" | "triage";
+    }>;
+    hasProjects?: boolean;
+    hasWiki?: boolean;
+    hasIssues?: boolean;
+    token?: string;
+    topics?: string[];
     repoVariables?: {
         [key: string]: string;
-    } | undefined;
+    };
     secrets?: {
         [key: string]: string;
-    } | undefined;
+    };
     oidcCustomization?: {
         useDefault: boolean;
-        includeClaimKeys?: string[] | undefined;
-    } | undefined;
-    requireCommitSigning?: boolean | undefined;
-    requiredLinearHistory?: boolean | undefined;
+        includeClaimKeys?: string[];
+    };
+    requireCommitSigning?: boolean;
+    requiredLinearHistory?: boolean;
     customProperties?: {
         [key: string]: string;
-    } | undefined;
-    subscribe?: boolean | undefined;
-}, _backstage_types.JsonObject>;
+    };
+    subscribe?: boolean;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -124,35 +124,35 @@ declare function createGithubRepoPushAction(options: {
     githubCredentialsProvider?: GithubCredentialsProvider;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
-    description?: string | undefined;
-    defaultBranch?: string | undefined;
-    protectDefaultBranch?: boolean | undefined;
-    protectEnforceAdmins?: boolean | undefined;
-    gitCommitMessage?: string | undefined;
-    gitAuthorName?: string | undefined;
-    gitAuthorEmail?: string | undefined;
-    requireCodeOwnerReviews?: boolean | undefined;
-    dismissStaleReviews?: boolean | undefined;
+    description?: string;
+    defaultBranch?: string;
+    protectDefaultBranch?: boolean;
+    protectEnforceAdmins?: boolean;
+    gitCommitMessage?: string;
+    gitAuthorName?: string;
+    gitAuthorEmail?: string;
+    requireCodeOwnerReviews?: boolean;
+    dismissStaleReviews?: boolean;
     bypassPullRequestAllowances?: {
         users?: string[];
         teams?: string[];
         apps?: string[];
     } | undefined;
-    requiredApprovingReviewCount?: number | undefined;
+    requiredApprovingReviewCount?: number;
     restrictions?: {
         users: string[];
         teams: string[];
         apps?: string[];
     } | undefined;
-    requiredStatusCheckContexts?: string[] | undefined;
-    requireBranchesToBeUpToDate?: boolean | undefined;
-    requiredConversationResolution?: boolean | undefined;
-    sourcePath?: string | undefined;
-    token?: string | undefined;
-    requiredCommitSigning?: boolean | undefined;
-    requiredLinearHistory?: boolean | undefined;
-    requireLastPushApproval?: boolean | undefined;
-}, _backstage_types.JsonObject>;
+    requiredStatusCheckContexts?: string[];
+    requireBranchesToBeUpToDate?: boolean;
+    requiredConversationResolution?: boolean;
+    sourcePath?: string;
+    token?: string;
+    requiredCommitSigning?: boolean;
+    requiredLinearHistory?: boolean;
+    requireLastPushApproval?: boolean;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates new action that creates a webhook for a repository on GitHub.
@@ -165,13 +165,13 @@ declare function createGithubWebhookAction(options: {
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
     webhookUrl: string;
-    webhookSecret?: string | undefined;
-    events?: string[] | undefined;
-    active?: boolean | undefined;
-    contentType?: "form" | "json" | undefined;
-    insecureSsl?: boolean | undefined;
-    token?: string | undefined;
-}, _backstage_types.JsonObject>;
+    webhookSecret?: string;
+    events?: string[];
+    active?: boolean;
+    contentType?: "form" | "json";
+    insecureSsl?: boolean;
+    token?: string;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates an `github:deployKey:create` Scaffolder action that creates a Deploy Key
@@ -185,9 +185,9 @@ declare function createGithubDeployKeyAction(options: {
     publicKey: string;
     privateKey: string;
     deployKeyName: string;
-    privateKeySecretName?: string | undefined;
-    token?: string | undefined;
-}, _backstage_types.JsonObject>;
+    privateKeySecretName?: string;
+    token?: string;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates an `github:environment:create` Scaffolder action that creates a Github Environment.
@@ -204,20 +204,20 @@ declare function createGithubEnvironmentAction(options: {
     deploymentBranchPolicy?: {
         protected_branches: boolean;
         custom_branch_policies: boolean;
-    } | undefined;
-    customBranchPolicyNames?: string[] | undefined;
-    customTagPolicyNames?: string[] | undefined;
+    };
+    customBranchPolicyNames?: string[];
+    customTagPolicyNames?: string[];
     environmentVariables?: {
         [key: string]: string;
-    } | undefined;
+    };
     secrets?: {
         [key: string]: string;
-    } | undefined;
-    token?: string | undefined;
-    waitTimer?: number | undefined;
-    preventSelfReview?: boolean | undefined;
-    reviewers?: string[] | undefined;
-}, _backstage_types.JsonObject>;
+    };
+    token?: string;
+    waitTimer?: number;
+    preventSelfReview?: boolean;
+    reviewers?: string[];
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * The options passed to {@link createPublishGithubPullRequestAction} method
@@ -265,23 +265,23 @@ interface CreateGithubPullRequestActionOptions {
 declare const createPublishGithubPullRequestAction: (options: CreateGithubPullRequestActionOptions) => _backstage_plugin_scaffolder_node.TemplateAction<{
     title: string;
     branchName: string;
-    targetBranchName?: string | undefined;
+    targetBranchName?: string;
     description: string;
     repoUrl: string;
-    draft?: boolean | undefined;
-    targetPath?: string | undefined;
-    sourcePath?: string | undefined;
-    token?: string | undefined;
-    reviewers?: string[] | undefined;
-    teamReviewers?: string[] | undefined;
-    commitMessage?: string | undefined;
-    update?: boolean | undefined;
-    forceFork?: boolean | undefined;
-    gitAuthorName?: string | undefined;
-    gitAuthorEmail?: string | undefined;
-    forceEmptyGitAuthor?: boolean | undefined;
-    createWhenEmpty?: boolean | undefined;
-}, _backstage_types.JsonObject>;
+    draft?: boolean;
+    targetPath?: string;
+    sourcePath?: string;
+    token?: string;
+    reviewers?: string[];
+    teamReviewers?: string[];
+    commitMessage?: string;
+    update?: boolean;
+    forceFork?: boolean;
+    gitAuthorName?: string;
+    gitAuthorEmail?: string;
+    forceEmptyGitAuthor?: boolean;
+    createWhenEmpty?: boolean;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates a new action that initializes a git repository of the content in the workspace
@@ -295,42 +295,42 @@ declare function createPublishGithubAction(options: {
     githubCredentialsProvider?: GithubCredentialsProvider;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
-    description?: string | undefined;
-    homepage?: string | undefined;
-    access?: string | undefined;
-    defaultBranch?: string | undefined;
-    protectDefaultBranch?: boolean | undefined;
-    protectEnforceAdmins?: boolean | undefined;
-    deleteBranchOnMerge?: boolean | undefined;
-    gitCommitMessage?: string | undefined;
-    gitAuthorName?: string | undefined;
-    gitAuthorEmail?: string | undefined;
-    allowRebaseMerge?: boolean | undefined;
-    allowSquashMerge?: boolean | undefined;
-    squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE" | undefined;
-    squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK" | undefined;
-    allowMergeCommit?: boolean | undefined;
-    allowAutoMerge?: boolean | undefined;
-    sourcePath?: string | undefined;
+    description?: string;
+    homepage?: string;
+    access?: string;
+    defaultBranch?: string;
+    protectDefaultBranch?: boolean;
+    protectEnforceAdmins?: boolean;
+    deleteBranchOnMerge?: boolean;
+    gitCommitMessage?: string;
+    gitAuthorName?: string;
+    gitAuthorEmail?: string;
+    allowRebaseMerge?: boolean;
+    allowSquashMerge?: boolean;
+    squashMergeCommitTitle?: "PR_TITLE" | "COMMIT_OR_PR_TITLE";
+    squashMergeCommitMessage?: "PR_BODY" | "COMMIT_MESSAGES" | "BLANK";
+    allowMergeCommit?: boolean;
+    allowAutoMerge?: boolean;
+    sourcePath?: string;
     bypassPullRequestAllowances?: {
         users?: string[];
         teams?: string[];
         apps?: string[];
     } | undefined;
-    requiredApprovingReviewCount?: number | undefined;
+    requiredApprovingReviewCount?: number;
     restrictions?: {
         users: string[];
         teams: string[];
         apps?: string[];
     } | undefined;
-    requireCodeOwnerReviews?: boolean | undefined;
-    dismissStaleReviews?: boolean | undefined;
-    requiredStatusCheckContexts?: string[] | undefined;
-    requireBranchesToBeUpToDate?: boolean | undefined;
-    requiredConversationResolution?: boolean | undefined;
-    requireLastPushApproval?: boolean | undefined;
-    repoVisibility?: "internal" | "private" | "public" | undefined;
-    collaborators?: ({
+    requireCodeOwnerReviews?: boolean;
+    dismissStaleReviews?: boolean;
+    requiredStatusCheckContexts?: string[];
+    requireBranchesToBeUpToDate?: boolean;
+    requiredConversationResolution?: boolean;
+    requireLastPushApproval?: boolean;
+    repoVisibility?: "private" | "internal" | "public";
+    collaborators?: Array<{
         user: string;
         access: string;
     } | {
@@ -339,30 +339,30 @@ declare function createPublishGithubAction(options: {
     } | {
         /** @deprecated This field is deprecated in favor of team */
         username: string;
-        access: 'pull' | 'push' | 'admin' | 'maintain' | 'triage';
-    })[] | undefined;
+        access: "pull" | "push" | "admin" | "maintain" | "triage";
+    }>;
     hasProjects?: boolean | undefined;
     hasWiki?: boolean | undefined;
     hasIssues?: boolean | undefined;
-    token?: string | undefined;
-    topics?: string[] | undefined;
+    token?: string;
+    topics?: string[];
     repoVariables?: {
         [key: string]: string;
-    } | undefined;
+    };
     secrets?: {
         [key: string]: string;
-    } | undefined;
+    };
     oidcCustomization?: {
         useDefault: boolean;
-        includeClaimKeys?: string[] | undefined;
-    } | undefined;
-    requiredCommitSigning?: boolean | undefined;
-    requiredLinearHistory?: boolean | undefined;
+        includeClaimKeys?: string[];
+    };
+    requiredCommitSigning?: boolean;
+    requiredLinearHistory?: boolean;
     customProperties?: {
         [key: string]: string;
-    } | undefined;
-    subscribe?: boolean | undefined;
-}, _backstage_types.JsonObject>;
+    };
+    subscribe?: boolean;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Create an autolink reference for a repository
@@ -375,9 +375,9 @@ declare function createGithubAutolinksAction(options: {
     repoUrl: string;
     keyPrefix: string;
     urlTemplate: string;
-    isAlphanumeric?: boolean | undefined;
-    token?: string | undefined;
-}, _backstage_types.JsonObject>;
+    isAlphanumeric?: boolean;
+    token?: string;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates a new action that enables GitHub Pages for a repository.
@@ -389,11 +389,11 @@ declare function createGithubPagesEnableAction(options: {
     githubCredentialsProvider?: GithubCredentialsProvider;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
-    buildType?: "legacy" | "workflow" | undefined;
-    sourceBranch?: string | undefined;
-    sourcePath?: "/" | "/docs" | undefined;
-    token?: string | undefined;
-}, _backstage_types.JsonObject>;
+    buildType?: "legacy" | "workflow";
+    sourceBranch?: string;
+    sourcePath?: "/" | "/docs";
+    token?: string;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * Creates an `github:branch-protection:create` Scaffolder action that configured Branch Protection in a Github Repository.
@@ -404,11 +404,11 @@ declare function createGithubBranchProtectionAction(options: {
     integrations: ScmIntegrationRegistry;
 }): _backstage_plugin_scaffolder_node.TemplateAction<{
     repoUrl: string;
-    branch?: string | undefined;
-    enforceAdmins?: boolean | undefined;
-    requiredApprovingReviewCount?: number | undefined;
-    requireCodeOwnerReviews?: boolean | undefined;
-    dismissStaleReviews?: boolean | undefined;
+    branch?: string;
+    enforceAdmins?: boolean;
+    requiredApprovingReviewCount?: number;
+    requireCodeOwnerReviews?: boolean;
+    dismissStaleReviews?: boolean;
     bypassPullRequestAllowances?: {
         users?: string[];
         teams?: string[];
@@ -419,14 +419,14 @@ declare function createGithubBranchProtectionAction(options: {
         teams: string[];
         apps?: string[];
     } | undefined;
-    requiredStatusCheckContexts?: string[] | undefined;
-    requireBranchesToBeUpToDate?: boolean | undefined;
-    requiredConversationResolution?: boolean | undefined;
-    requireLastPushApproval?: boolean | undefined;
-    requiredCommitSigning?: boolean | undefined;
-    requiredLinearHistory?: boolean | undefined;
-    token?: string | undefined;
-}, _backstage_types.JsonObject>;
+    requiredStatusCheckContexts?: string[];
+    requireBranchesToBeUpToDate?: boolean;
+    requiredConversationResolution?: boolean;
+    requireLastPushApproval?: boolean;
+    requiredCommitSigning?: boolean;
+    requiredLinearHistory?: boolean;
+    token?: string;
+}, _backstage_types.JsonObject, "v1">;
 
 /**
  * @public

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend-module-github",
-  "version": "0.6.1-next.1",
+  "version": "0.6.1",
   "description": "The github module for @backstage/plugin-scaffolder-backend",
   "backstage": {
     "role": "backend-plugin-module",
@@ -30,13 +30,6 @@
   },
   "main": "./dist/index.cjs.js",
   "types": "./dist/index.d.ts",
-  "typesVersions": {
-    "*": {
-      "index": [
-        "dist/index.d.ts"
-      ]
-    }
-  },
   "files": [
     "dist"
   ],
@@ -50,13 +43,14 @@
     "test": "backstage-cli package test"
   },
   "dependencies": {
-    "@backstage/backend-plugin-api": "1.2.1-next.1",
-    "@backstage/catalog-client": "1.9.1",
-    "@backstage/catalog-model": "1.7.3",
-    "@backstage/config": "1.3.2",
-    "@backstage/errors": "1.2.7",
-    "@backstage/integration": "1.16.1",
-    "@backstage/plugin-scaffolder-node": "0.7.1-next.1",
+    "@backstage/backend-plugin-api": "^1.2.1",
+    "@backstage/catalog-client": "^1.9.1",
+    "@backstage/catalog-model": "^1.7.3",
+    "@backstage/config": "^1.3.2",
+    "@backstage/errors": "^1.2.7",
+    "@backstage/integration": "^1.16.2",
+    "@backstage/plugin-scaffolder-node": "^0.8.0",
+    "@backstage/types": "^1.2.1",
     "@octokit/webhooks": "^10.9.2",
     "libsodium-wrappers": "^0.7.11",
     "octokit": "^3.0.0",
@@ -64,9 +58,9 @@
     "yaml": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.3.1-next.1",
-    "@backstage/cli": "0.30.1-next.0",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.1.20-next.1",
+    "@backstage/backend-test-utils": "^1.3.1",
+    "@backstage/cli": "^0.31.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "^0.2.0",
     "@types/libsodium-wrappers": "^0.7.10",
     "fs-extra": "^11.2.0",
     "jsonschema": "^1.2.6"