@backstage/plugin-scaffolder-backend 1.10.0-next.1 → 1.10.0

package/CHANGELOG.md

@@ -1,5 +1,218 @@
 # @backstage/plugin-scaffolder-backend
 
+## 1.10.0
+
+### Minor Changes
+
+- a6808b67a7: Implement `Required approving review count`, `Restrictions`, and `Required commit signing` support for `publish:github` action
+- 04a2048fb8: Allow custom repository roles to be configured on github repos
+- c0ad7341f7: Add Scaffolder action `catalog:fetch` to get entity by entity reference from catalog
+- b44eb68bcb: This change adds changes to provide examples alongside scaffolder task actions.
+
+  The `createTemplateAction` function now takes a list of examples e.g.
+
+  ```typescript
+  const actionExamples = [
+    {
+      description: 'Example 1',
+      example: yaml.stringify({
+        steps: [
+          {
+            action: 'test:action',
+            id: 'test',
+            input: {
+              input1: 'value',
+            },
+          },
+        ],
+      }),
+    },
+  ];
+
+  export function createTestAction() {
+    return createTemplateAction({
+        id: 'test:action',
+        examples: [
+            {
+                description: 'Example 1',
+                examples: actionExamples
+            }
+        ],
+        ...,
+    });
+  ```
+
+  These examples can be retrieved later from the api.
+
+  ```bash
+  curl http://localhost:7007/api/scaffolder/v2/actions
+  ```
+
+  ```json
+  [
+    {
+      "id": "test:action",
+      "examples": [
+        {
+          "description": "Example 1",
+          "example": "steps:\n  - action: test:action\n    id: test\n    input:\n      input1: value\n"
+        }
+      ],
+      "schema": {
+        "input": {
+          "type": "object",
+          "properties": {
+            "input1": {
+              "title": "Input 1",
+              "type": "string"
+            }
+          }
+        }
+      }
+    }
+  ]
+  ```
+
+- 72d6b9f4e2: Added ability to override the commit message and author details for the `publish:bitbucketServer` action.
+- a69664faee: Add Github repository support for squash merge commit title and message options
+
+### Patch Changes
+
+- 2fadff2a25: Change scaffolder task actions to include markdown to demonstrate the new `ActionsPage` markdown feature.
+- ecbec4ec4c: Internal refactor to match new options pattern in the experimental backend system.
+- e4c0240445: Added `catalogFilter` field to OwnerPicker and EntityPicker components to support filtering options by any field(s) of an entity.
+
+  The `allowedKinds` field has been deprecated. Use `catalogFilter` instead. This field allows users to specify a filter on the shape of [EntityFilterQuery](https://github.com/backstage/backstage/blob/774c42003782121d3d6b2aa5f2865d53370c160e/packages/catalog-client/src/types/api.ts#L74), which can be passed into the CatalogClient. See examples below:
+
+  - Get all entities of kind `Group`
+
+    ```yaml
+    owner:
+      title: Owner
+      type: string
+      description: Owner of the component
+      ui:field: OwnerPicker
+      ui:options:
+        catalogFilter:
+          - kind: Group
+    ```
+
+  - Get entities of kind `Group` and spec.type `team`
+    ```yaml
+    owner:
+      title: Owner
+      type: string
+      description: Owner of the component
+      ui:field: OwnerPicker
+      ui:options:
+        catalogFilter:
+          - kind: Group
+            spec.type: team
+    ```
+
+- 8e06f3cf00: Switched imports of `loggerToWinstonLogger` to `@backstage/backend-common`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.3.0
+  - @backstage/backend-common@0.18.0
+  - @backstage/catalog-model@1.1.5
+  - @backstage/plugin-scaffolder-common@1.2.4
+  - @backstage/catalog-client@1.3.0
+  - @backstage/backend-tasks@0.4.1
+  - @backstage/plugin-catalog-node@1.3.1
+  - @backstage/plugin-catalog-backend@1.7.0
+  - @backstage/config@1.0.6
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.2
+  - @backstage/types@1.0.2
+  - @backstage/plugin-auth-node@0.2.9
+
+## 1.10.0-next.2
+
+### Patch Changes
+
+- 2fadff2a25: Change scaffolder task actions to include markdown to demonstrate the new `ActionsPage` markdown feature.
+- b44eb68bcb: This patch adds changes to provide examples alongside scaffolder task actions.
+
+  The `createTemplateAction` function now takes a list of examples e.g.
+
+  ```typescript
+  const actionExamples = [
+    {
+      description: 'Example 1',
+      example: yaml.stringify({
+        steps: [
+          {
+            action: 'test:action',
+            id: 'test',
+            input: {
+              input1: 'value',
+            },
+          },
+        ],
+      }),
+    },
+  ];
+
+  export function createTestAction() {
+    return createTemplateAction({
+        id: 'test:action',
+        examples: [
+            {
+                description: 'Example 1',
+                examples: actionExamples
+            }
+        ],
+        ...,
+    });
+  ```
+
+  These examples can be retrieved later from the api.
+
+  ```bash
+  curl http://localhost:7007/api/scaffolder/v2/actions
+  ```
+
+  ```json
+  [
+    {
+      "id": "test:action",
+      "examples": [
+        {
+          "description": "Example 1",
+          "example": "steps:\n  - action: test:action\n    id: test\n    input:\n      input1: value\n"
+        }
+      ],
+      "schema": {
+        "input": {
+          "type": "object",
+          "properties": {
+            "input1": {
+              "title": "Input 1",
+              "type": "string"
+            }
+          }
+        }
+      }
+    }
+  ]
+  ```
+
+- 8e06f3cf00: Switched imports of `loggerToWinstonLogger` to `@backstage/backend-common`.
+- Updated dependencies
+  - @backstage/backend-plugin-api@0.3.0-next.1
+  - @backstage/backend-common@0.18.0-next.1
+  - @backstage/backend-tasks@0.4.1-next.1
+  - @backstage/catalog-client@1.3.0-next.2
+  - @backstage/plugin-catalog-backend@1.7.0-next.2
+  - @backstage/plugin-catalog-node@1.3.1-next.2
+  - @backstage/plugin-auth-node@0.2.9-next.1
+  - @backstage/catalog-model@1.1.5-next.1
+  - @backstage/config@1.0.6-next.0
+  - @backstage/errors@1.1.4
+  - @backstage/integration@1.4.2-next.0
+  - @backstage/types@1.0.2
+  - @backstage/plugin-scaffolder-common@1.2.4-next.1
+
 ## 1.10.0-next.1
 
 ### Minor Changes

package/alpha/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/plugin-scaffolder-backend",
-  "version": "1.10.0-next.1",
+  "version": "1.10.0",
   "main": "../dist/index.cjs.js",
   "types": "../dist/index.alpha.d.ts"
 }

package/dist/index.alpha.d.ts

@@ -150,6 +150,17 @@ message?: string | undefined;
 listWorkspace?: boolean | undefined;
 }>;
 
+/**
+ * Returns entity from the catalog by entity reference.
+ * @public
+ */
+export declare function createFetchCatalogEntityAction(options: {
+    catalogClient: CatalogApi;
+}): TemplateAction<    {
+entityRef: string;
+optional?: boolean | undefined;
+}>;
+
 /**
  * Downloads content and places it in the workspace, or optionally
  * in a subdirectory specified by the 'targetPath' input option.
@@ -299,6 +310,12 @@ users?: string[] | undefined;
 teams?: string[] | undefined;
 apps?: string[] | undefined;
 } | undefined;
+requiredApprovingReviewCount?: number | undefined;
+restrictions?: {
+users: string[];
+teams: string[];
+apps?: string[] | undefined;
+} | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 requiredConversationResolution?: boolean | undefined;
@@ -319,6 +336,7 @@ hasWiki?: boolean | undefined;
 hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
+requireCommitSigning?: boolean | undefined;
 }>;
 
 /**
@@ -347,11 +365,18 @@ users?: string[];
 teams?: string[];
 apps?: string[];
 } | undefined;
+requiredApprovingReviewCount?: number | undefined;
+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;
 }>;
 
 /**
@@ -447,6 +472,9 @@ repoVisibility?: "private" | "public" | undefined;
 sourcePath?: string | undefined;
 enableLFS?: boolean | undefined;
 token?: string | undefined;
+gitCommitMessage?: string | undefined;
+gitAuthorName?: string | undefined;
+gitAuthorEmail?: string | undefined;
 }>;
 
 /**
@@ -517,6 +545,12 @@ users?: string[];
 teams?: string[];
 apps?: string[];
 } | undefined;
+requiredApprovingReviewCount?: number | undefined;
+restrictions?: {
+users: string[];
+teams: string[];
+apps?: string[];
+} | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
@@ -539,6 +573,7 @@ hasWiki?: boolean | undefined;
 hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
+requiredCommitSigning?: boolean | undefined;
 }>;
 
 /**
@@ -792,7 +827,7 @@ export declare type RunCommandOptions = {
  * @alpha
  * Registers the ScaffolderEntitiesProcessor with the catalog processing extension point.
  */
-export declare const scaffolderCatalogModule: (options?: undefined) => BackendFeature;
+export declare const scaffolderCatalogModule: () => BackendFeature;
 
 /** @public */
 export declare class ScaffolderEntitiesProcessor implements CatalogProcessor {
@@ -1063,6 +1098,10 @@ export declare class TaskWorker {
 export declare type TemplateAction<Input extends JsonObject> = {
     id: string;
     description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
     supportsDryRun?: boolean;
     schema?: {
         input?: Schema;

package/dist/index.beta.d.ts

@@ -150,6 +150,17 @@ message?: string | undefined;
 listWorkspace?: boolean | undefined;
 }>;
 
+/**
+ * Returns entity from the catalog by entity reference.
+ * @public
+ */
+export declare function createFetchCatalogEntityAction(options: {
+    catalogClient: CatalogApi;
+}): TemplateAction<    {
+entityRef: string;
+optional?: boolean | undefined;
+}>;
+
 /**
  * Downloads content and places it in the workspace, or optionally
  * in a subdirectory specified by the 'targetPath' input option.
@@ -299,6 +310,12 @@ users?: string[] | undefined;
 teams?: string[] | undefined;
 apps?: string[] | undefined;
 } | undefined;
+requiredApprovingReviewCount?: number | undefined;
+restrictions?: {
+users: string[];
+teams: string[];
+apps?: string[] | undefined;
+} | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
 requireBranchesToBeUpToDate?: boolean | undefined;
 requiredConversationResolution?: boolean | undefined;
@@ -319,6 +336,7 @@ hasWiki?: boolean | undefined;
 hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
+requireCommitSigning?: boolean | undefined;
 }>;
 
 /**
@@ -347,11 +365,18 @@ users?: string[];
 teams?: string[];
 apps?: string[];
 } | undefined;
+requiredApprovingReviewCount?: number | undefined;
+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;
 }>;
 
 /**
@@ -447,6 +472,9 @@ repoVisibility?: "private" | "public" | undefined;
 sourcePath?: string | undefined;
 enableLFS?: boolean | undefined;
 token?: string | undefined;
+gitCommitMessage?: string | undefined;
+gitAuthorName?: string | undefined;
+gitAuthorEmail?: string | undefined;
 }>;
 
 /**
@@ -517,6 +545,12 @@ users?: string[];
 teams?: string[];
 apps?: string[];
 } | undefined;
+requiredApprovingReviewCount?: number | undefined;
+restrictions?: {
+users: string[];
+teams: string[];
+apps?: string[];
+} | undefined;
 requireCodeOwnerReviews?: boolean | undefined;
 dismissStaleReviews?: boolean | undefined;
 requiredStatusCheckContexts?: string[] | undefined;
@@ -539,6 +573,7 @@ hasWiki?: boolean | undefined;
 hasIssues?: boolean | undefined;
 token?: string | undefined;
 topics?: string[] | undefined;
+requiredCommitSigning?: boolean | undefined;
 }>;
 
 /**
@@ -1045,6 +1080,10 @@ export declare class TaskWorker {
 export declare type TemplateAction<Input extends JsonObject> = {
     id: string;
     description?: string;
+    examples?: {
+        description: string;
+        example: string;
+    }[];
     supportsDryRun?: boolean;
     schema?: {
         input?: Schema;