@backstage/plugin-scaffolder-backend 0.18.0 → 1.1.0-next.1

package/dist/index.d.ts

@@ -239,10 +239,26 @@ declare type TemplateAction<Input extends JsonObject> = {
  * @public
  */
 interface CreateBuiltInActionsOptions {
+    /**
+     * The {@link @backstage/backend-common#UrlReader} interface that will be used in the default actions.
+     */
     reader: UrlReader;
+    /**
+     * The {@link @backstage/integrations#ScmIntegrations} that will be used in the default actions.
+     */
     integrations: ScmIntegrations;
+    /**
+     * The {@link @backstage/catalog-client#CatalogApi} that will be used in the default actions.
+     */
     catalogClient: CatalogApi;
+    /**
+     * The {@link @backstage/config#Config} that will be used in the default actions.
+     */
     config: Config;
+    /**
+     * Additional custom filters that will be passed to the nunjucks template engine for use in
+     * Template Manifests and also template skeleton files when using `fetch:template`.
+     */
     additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
 /**
@@ -420,10 +436,14 @@ interface OctokitWithPullRequestPluginClient {
     createPullRequest(options: createPullRequest.Options): Promise<{
         data: {
             html_url: string;
+            number: number;
         };
     } | null>;
 }
-/** @public */
+/**
+ * The options passed to the client factory function.
+ * @public
+ */
 declare type CreateGithubPullRequestClientFactoryInput = {
     integrations: ScmIntegrationRegistry;
     githubCredentialsProvider?: GithubCredentialsProvider;
@@ -432,10 +452,22 @@ declare type CreateGithubPullRequestClientFactoryInput = {
     repo: string;
     token?: string;
 };
-/** @public */
+/**
+ * The options passed to {@link createPublishGithubPullRequestAction} method
+ * @public
+ */
 interface CreateGithubPullRequestActionOptions {
+    /**
+     * An instance of {@link @backstage/integration#ScmIntegrationRegistry} that will be used in the action.
+     */
     integrations: ScmIntegrationRegistry;
+    /**
+     * An instance of {@link @backstage/integration#GithubCredentialsProvider} that will be used to get credentials for the action.
+     */
     githubCredentialsProvider?: GithubCredentialsProvider;
+    /**
+     * A method to return the Octokit client with the Pull Request Plugin.
+     */
     clientFactory?: (input: CreateGithubPullRequestClientFactoryInput) => Promise<OctokitWithPullRequestPluginClient>;
 }
 /**
@@ -447,6 +479,7 @@ declare const createPublishGithubPullRequestAction: ({ integrations, githubCrede
     branchName: string;
     description: string;
     repoUrl: string;
+    draft?: boolean | undefined;
     targetPath?: string | undefined;
     sourcePath?: string | undefined;
     token?: string | undefined;
@@ -467,6 +500,9 @@ declare function createPublishGitlabAction(options: {
     repoVisibility?: "internal" | "private" | "public" | undefined;
     sourcePath?: string | undefined;
     token?: string | undefined;
+    gitCommitMessage?: string | undefined;
+    gitAuthorName?: string | undefined;
+    gitAuthorEmail?: string | undefined;
 }>;
 
 /**
@@ -522,6 +558,20 @@ declare function createGithubWebhookAction(options: {
     token?: string | undefined;
 }>;
 
+/**
+ * Adds labels to a pull request or issue on GitHub
+ * @public
+ */
+declare function createGithubIssuesLabelAction(options: {
+    integrations: ScmIntegrationRegistry;
+    githubCredentialsProvider?: GithubCredentialsProvider;
+}): TemplateAction<{
+    repoUrl: string;
+    number: number;
+    labels: string[];
+    token?: string | undefined;
+}>;
+
 /** @public */
 declare type RunCommandOptions = {
     /** command to run */
@@ -625,8 +675,17 @@ declare class TaskManager implements TaskContext {
  * @public
  */
 interface CurrentClaimedTask {
+    /**
+     * The TaskSpec of the current claimed task.
+     */
     spec: TaskSpec;
+    /**
+     * The uuid of the current claimed task.
+     */
     taskId: string;
+    /**
+     * The secrets that are stored with the task.
+     */
     secrets?: TaskSecrets;
 }
 
@@ -672,7 +731,10 @@ interface RouterOptions {
     taskBroker?: TaskBroker;
     additionalTemplateFilters?: Record<string, TemplateFilter>;
 }
-/** @public */
+/**
+ * A method to create a router for the scaffolder backend plugin.
+ * @public
+ */
 declare function createRouter(options: RouterOptions): Promise<express.Router>;
 
 /** @public */
@@ -683,4 +745,4 @@ declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
     postProcessEntity(entity: Entity, _location: LocationSpec, emit: CatalogProcessorEmit): Promise<Entity>;
 }
 
-export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents };
+export { ActionContext, CreateBuiltInActionsOptions, CreateGithubPullRequestActionOptions, CreateGithubPullRequestClientFactoryInput, CreateWorkerOptions, CurrentClaimedTask, DatabaseTaskStore, DatabaseTaskStoreOptions, OctokitWithPullRequestPluginClient, RouterOptions, RunCommandOptions, ScaffolderEntitiesProcessor, SerializedTask, SerializedTaskEvent, TaskBroker, TaskBrokerDispatchOptions, TaskBrokerDispatchResult, TaskCompletionState, TaskContext, TaskEventType, TaskManager, TaskSecrets, TaskStatus, TaskStore, TaskStoreCreateTaskOptions, TaskStoreCreateTaskResult, TaskStoreEmitOptions, TaskStoreListEventsOptions, TaskWorker, TemplateAction, TemplateActionRegistry, TemplateFilter, createBuiltinActions, createCatalogRegisterAction, createCatalogWriteAction, createDebugLogAction, createFetchPlainAction, createFetchTemplateAction, createFilesystemDeleteAction, createFilesystemRenameAction, createGithubActionsDispatchAction, createGithubIssuesLabelAction, createGithubWebhookAction, createPublishAzureAction, createPublishBitbucketAction, createPublishFileAction, createPublishGithubAction, createPublishGithubPullRequestAction, createPublishGitlabAction, createPublishGitlabMergeRequestAction, createRouter, createTemplateAction, executeShellCommand, fetchContents };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
   "description": "The Backstage backend plugin that helps you create new things",
-  "version": "0.18.0",
+  "version": "1.1.0-next.1",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "license": "Apache-2.0",
@@ -34,15 +34,15 @@
     "build:assets": "node scripts/build-nunjucks.js"
   },
   "dependencies": {
-    "@backstage/backend-common": "^0.13.0",
-    "@backstage/catalog-client": "^0.9.0",
-    "@backstage/catalog-model": "^0.13.0",
-    "@backstage/config": "^0.1.15",
-    "@backstage/errors": "^0.2.2",
-    "@backstage/integration": "^0.8.0",
-    "@backstage/plugin-catalog-backend": "^0.24.0",
-    "@backstage/plugin-scaffolder-common": "^0.3.0",
-    "@backstage/types": "^0.1.3",
+    "@backstage/backend-common": "^0.13.2-next.1",
+    "@backstage/catalog-client": "^1.0.1-next.0",
+    "@backstage/catalog-model": "^1.0.1-next.0",
+    "@backstage/config": "^1.0.0",
+    "@backstage/errors": "^1.0.0",
+    "@backstage/integration": "^1.1.0-next.1",
+    "@backstage/plugin-catalog-backend": "^1.1.0-next.1",
+    "@backstage/plugin-scaffolder-common": "^1.0.1-next.0",
+    "@backstage/types": "^1.0.0",
     "@gitbeaker/core": "^34.6.0",
     "@gitbeaker/node": "^35.1.0",
     "@octokit/webhooks": "^9.14.1",
@@ -74,8 +74,8 @@
     "zen-observable": "^0.8.15"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.1.21",
-    "@backstage/cli": "^0.15.2",
+    "@backstage/backend-test-utils": "^0.1.23-next.1",
+    "@backstage/cli": "^0.17.0-next.1",
     "@types/command-exists": "^1.2.0",
     "@types/fs-extra": "^9.0.1",
     "@types/git-url-parse": "^9.0.0",
@@ -97,5 +97,5 @@
     "assets"
   ],
   "configSchema": "config.d.ts",
-  "gitHead": "60c4e39d1fcaeb10d6488ada1d907f34dc2a105a"
+  "gitHead": "57d12dcc35aeb6c33b09e51d1efc3408c574f109"
 }