@backstage/plugin-scaffolder-backend-module-sentry 0.0.0-nightly-20230112022659

package/CHANGELOG.md

@@ -0,0 +1,15 @@
+# @backstage/plugin-scaffolder-backend-module-sentry
+
+## 0.0.0-nightly-20230112022659
+
+### Minor Changes
+
+- 66ff367af6: Add Sentry "Create Project" Scaffolder as new package
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/plugin-scaffolder-backend@0.0.0-nightly-20230112022659
+  - @backstage/config@0.0.0-nightly-20230112022659
+  - @backstage/errors@1.1.4
+  - @backstage/integration@0.0.0-nightly-20230112022659

package/README.md

@@ -0,0 +1,160 @@
+# scaffolder-backend-module-sentry
+
+Welcome to the Sentry Module for Scaffolder.
+
+Here you can find all Sentry related features to improve your scaffolder:
+
+## Getting started
+
+You need to configure the action in your backend:
+
+## From your Backstage root directory
+
+```bash
+# From your Backstage root directory
+yarn add --cwd packages/backend @backstage/plugin-scaffolder-backend-module-sentry
+```
+
+Configure the action (you can check
+the [docs](https://backstage.io/docs/features/software-templates/writing-custom-actions#registering-custom-actions) to
+see all options):
+
+```typescript
+const actions = [
+  createSentryCreateProjectAction({
+    integrations,
+    reader: env.reader,
+    containerRunner,
+  }),
+];
+
+return await createRouter({
+  containerRunner,
+  catalogClient,
+  actions,
+  logger: env.logger,
+  config: env.config,
+  database: env.database,
+  reader: env.reader,
+});
+```
+
+You need to define your Sentry API Token in your `app-config.yaml`:
+
+```yaml
+scaffolder:
+  sentry:
+    token: ${SENTRY_TOKEN}
+```
+
+After that you can use the action in your template:
+
+```yaml
+apiVersion: scaffolder.backstage.io/v1beta3
+kind: Template
+metadata:
+  name: sentry-demo
+  title: Sentry template
+  description: scaffolder sentry app
+spec:
+  owner: backstage/techdocs-core
+  type: service
+
+  parameters:
+    - title: Fill in some steps
+      required:
+        - name
+        - owner
+      properties:
+        name:
+          title: Name
+          type: string
+          description: Unique name of the component
+          ui:autofocus: true
+          ui:options:
+            rows: 5
+        owner:
+          title: Owner
+          type: string
+          description: Owner of the component
+          ui:field: OwnerPicker
+          ui:options:
+            catalogFilter:
+              kind: Group
+        system:
+          title: System
+          type: string
+          description: System of the component
+          ui:field: EntityPicker
+          ui:options:
+            catalogFilter:
+              kind: System
+            defaultKind: System
+
+    - title: Choose a location
+      required:
+        - repoUrl
+        - dryRun
+      properties:
+        repoUrl:
+          title: Repository Location
+          type: string
+          ui:field: RepoUrlPicker
+          ui:options:
+            allowedHosts:
+              - github.com
+        dryRun:
+          title: Only perform a dry run, don't publish anything
+          type: boolean
+          default: false
+
+  steps:
+    - id: fetch
+      name: Fetch
+      action: fetch:template
+      input:
+        url: https://github.com/TEMPLATE
+        values:
+          name: ${{ parameters.name }}
+
+    - id: create-sentry-project
+      if: ${{ parameters.dryRun !== true }}
+      name: Create Sentry Project
+      action: sentry:create-project
+      input:
+        organizationSlug: ORG-SLUG
+        teamSlug: TEAM-SLUG
+        name: ${{ parameters.name }}
+
+    - id: publish
+      if: ${{ parameters.dryRun !== true }}
+      name: Publish
+      action: publish:github
+      input:
+        allowedHosts:
+          - github.com
+        description: This is ${{ parameters.name }}
+        repoUrl: ${{ parameters.repoUrl }}
+
+    - id: register
+      if: ${{ parameters.dryRun !== true }}
+      name: Register
+      action: catalog:register
+      input:
+        repoContentsUrl: ${{ steps['publish'].output.repoContentsUrl }}
+        catalogInfoPath: '/catalog-info.yaml'
+
+    - name: Results
+      if: ${{ parameters.dryRun }}
+      action: debug:log
+      input:
+        listWorkspace: true
+
+  output:
+    links:
+      - title: Repository
+        url: ${{ steps['publish'].output.remoteUrl }}
+      - title: Open in catalog
+        icon: catalog
+        entityRef: ${{ steps['register'].output.entityRef }}
+```

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import * as _backstage_plugin_scaffolder_backend from '@backstage/plugin-scaffolder-backend';
+import { Config } from '@backstage/config';
+
+/**
+ * Creates the `sentry:craete-project` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.
+ *
+ * @param options - Configuration of the Sentry API.
+ * @public
+ */
+declare function createSentryCreateProjectAction(options: {
+    config: Config;
+}): _backstage_plugin_scaffolder_backend.TemplateAction<{
+    organizationSlug: string;
+    teamSlug: string;
+    name: string;
+    slug?: string | undefined;
+    authToken?: string | undefined;
+}>;
+
+export { createSentryCreateProjectAction };

package/dist/index.esm.js

@@ -0,0 +1,77 @@
+import { createTemplateAction } from '@backstage/plugin-scaffolder-backend';
+import { InputError } from '@backstage/errors';
+
+function createSentryCreateProjectAction(options) {
+  const { config } = options;
+  return createTemplateAction({
+    id: "sentry:project:create",
+    schema: {
+      input: {
+        required: ["organizationSlug", "teamSlug", "name"],
+        type: "object",
+        properties: {
+          organizationSlug: {
+            title: "The slug of the organization the team belongs to",
+            type: "string"
+          },
+          teamSlug: {
+            title: "The slug of the team to create a new project for",
+            type: "string"
+          },
+          name: {
+            title: "The name for the new project",
+            type: "string"
+          },
+          slug: {
+            title: "Optional slug for the new project. If not provided a slug is generated from the name",
+            type: "string"
+          },
+          authToken: {
+            title: "authenticate via bearer auth token. Requires scope: project:write",
+            type: "string"
+          }
+        }
+      }
+    },
+    async handler(ctx) {
+      const { organizationSlug, teamSlug, name, slug, authToken } = ctx.input;
+      const body = {
+        name
+      };
+      if (slug) {
+        body.slug = slug;
+      }
+      const token = authToken ? authToken : config.getOptionalString("scaffolder.sentry.token");
+      if (!token) {
+        throw new InputError(`No valid sentry token given`);
+      }
+      const response = await fetch(
+        `https://sentry.io/api/0/teams/${organizationSlug}/${teamSlug}/projects/`,
+        {
+          method: "POST",
+          headers: {
+            Authorization: `Bearer ${token}`,
+            "Content-Type": "application/json"
+          },
+          body: JSON.stringify(body)
+        }
+      );
+      const contentType = response.headers.get("content-type");
+      if (contentType !== "application/json") {
+        throw new InputError(
+          `Unexpected Sentry Response Type: ${await response.text()}`
+        );
+      }
+      const code = response.status;
+      const result = await response.json();
+      if (code !== 201) {
+        throw new InputError(`Sentry Response was: ${await result.detail}`);
+      }
+      ctx.output("id", result.id);
+      ctx.output("result", result);
+    }
+  });
+}
+
+export { createSentryCreateProjectAction };
+//# sourceMappingURL=index.esm.js.map

package/dist/index.esm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.esm.js","sources":["../src/actions/createProject.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 { createTemplateAction } from '@backstage/plugin-scaffolder-backend';\nimport { InputError } from '@backstage/errors';\nimport { Config } from '@backstage/config';\n\n/**\n * Creates the `sentry:craete-project` Scaffolder action.\n *\n * @remarks\n *\n * See {@link https://backstage.io/docs/features/software-templates/writing-custom-actions}.\n *\n * @param options - Configuration of the Sentry API.\n * @public\n */\nexport function createSentryCreateProjectAction(options: { config: Config }) {\n  const { config } = options;\n\n  return createTemplateAction<{\n    organizationSlug: string;\n    teamSlug: string;\n    name: string;\n    slug?: string;\n    authToken?: string;\n  }>({\n    id: 'sentry:project:create',\n    schema: {\n      input: {\n        required: ['organizationSlug', 'teamSlug', 'name'],\n        type: 'object',\n        properties: {\n          organizationSlug: {\n            title: 'The slug of the organization the team belongs to',\n            type: 'string',\n          },\n          teamSlug: {\n            title: 'The slug of the team to create a new project for',\n            type: 'string',\n          },\n          name: {\n            title: 'The name for the new project',\n            type: 'string',\n          },\n          slug: {\n            title:\n              'Optional slug for the new project. If not provided a slug is generated from the name',\n            type: 'string',\n          },\n          authToken: {\n            title:\n              'authenticate via bearer auth token. Requires scope: project:write',\n            type: 'string',\n          },\n        },\n      },\n    },\n    async handler(ctx) {\n      const { organizationSlug, teamSlug, name, slug, authToken } = ctx.input;\n\n      const body: any = {\n        name: name,\n      };\n\n      if (slug) {\n        body.slug = slug;\n      }\n\n      const token = authToken\n        ? authToken\n        : config.getOptionalString('scaffolder.sentry.token');\n\n      if (!token) {\n        throw new InputError(`No valid sentry token given`);\n      }\n\n      const response = await fetch(\n        `https://sentry.io/api/0/teams/${organizationSlug}/${teamSlug}/projects/`,\n        {\n          method: 'POST',\n          headers: {\n            Authorization: `Bearer ${token}`,\n            'Content-Type': 'application/json',\n          },\n          body: JSON.stringify(body),\n        },\n      );\n\n      const contentType = response.headers.get('content-type');\n\n      if (contentType !== 'application/json') {\n        throw new InputError(\n          `Unexpected Sentry Response Type: ${await response.text()}`,\n        );\n      }\n\n      const code = response.status;\n      const result = await response.json();\n\n      if (code !== 201) {\n        throw new InputError(`Sentry Response was: ${await result.detail}`);\n      }\n\n      ctx.output('id', result.id);\n      ctx.output('result', result);\n    },\n  });\n}\n"],"names":[],"mappings":";;;AA8BO,SAAS,gCAAgC,OAA6B,EAAA;AAC3E,EAAM,MAAA,EAAE,QAAW,GAAA,OAAA,CAAA;AAEnB,EAAA,OAAO,oBAMJ,CAAA;AAAA,IACD,EAAI,EAAA,uBAAA;AAAA,IACJ,MAAQ,EAAA;AAAA,MACN,KAAO,EAAA;AAAA,QACL,QAAU,EAAA,CAAC,kBAAoB,EAAA,UAAA,EAAY,MAAM,CAAA;AAAA,QACjD,IAAM,EAAA,QAAA;AAAA,QACN,UAAY,EAAA;AAAA,UACV,gBAAkB,EAAA;AAAA,YAChB,KAAO,EAAA,kDAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,QAAU,EAAA;AAAA,YACR,KAAO,EAAA,kDAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KAAO,EAAA,8BAAA;AAAA,YACP,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,IAAM,EAAA;AAAA,YACJ,KACE,EAAA,sFAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,UACA,SAAW,EAAA;AAAA,YACT,KACE,EAAA,mEAAA;AAAA,YACF,IAAM,EAAA,QAAA;AAAA,WACR;AAAA,SACF;AAAA,OACF;AAAA,KACF;AAAA,IACA,MAAM,QAAQ,GAAK,EAAA;AACjB,MAAA,MAAM,EAAE,gBAAkB,EAAA,QAAA,EAAU,MAAM,IAAM,EAAA,SAAA,KAAc,GAAI,CAAA,KAAA,CAAA;AAElE,MAAA,MAAM,IAAY,GAAA;AAAA,QAChB,IAAA;AAAA,OACF,CAAA;AAEA,MAAA,IAAI,IAAM,EAAA;AACR,QAAA,IAAA,CAAK,IAAO,GAAA,IAAA,CAAA;AAAA,OACd;AAEA,MAAA,MAAM,KAAQ,GAAA,SAAA,GACV,SACA,GAAA,MAAA,CAAO,kBAAkB,yBAAyB,CAAA,CAAA;AAEtD,MAAA,IAAI,CAAC,KAAO,EAAA;AACV,QAAM,MAAA,IAAI,WAAW,CAA6B,2BAAA,CAAA,CAAA,CAAA;AAAA,OACpD;AAEA,MAAA,MAAM,WAAW,MAAM,KAAA;AAAA,QACrB,iCAAiC,gBAAoB,CAAA,CAAA,EAAA,QAAA,CAAA,UAAA,CAAA;AAAA,QACrD;AAAA,UACE,MAAQ,EAAA,MAAA;AAAA,UACR,OAAS,EAAA;AAAA,YACP,eAAe,CAAU,OAAA,EAAA,KAAA,CAAA,CAAA;AAAA,YACzB,cAAgB,EAAA,kBAAA;AAAA,WAClB;AAAA,UACA,IAAA,EAAM,IAAK,CAAA,SAAA,CAAU,IAAI,CAAA;AAAA,SAC3B;AAAA,OACF,CAAA;AAEA,MAAA,MAAM,WAAc,GAAA,QAAA,CAAS,OAAQ,CAAA,GAAA,CAAI,cAAc,CAAA,CAAA;AAEvD,MAAA,IAAI,gBAAgB,kBAAoB,EAAA;AACtC,QAAA,MAAM,IAAI,UAAA;AAAA,UACR,CAAA,iCAAA,EAAoC,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA,CAAA;AAAA,SAC1D,CAAA;AAAA,OACF;AAEA,MAAA,MAAM,OAAO,QAAS,CAAA,MAAA,CAAA;AACtB,MAAM,MAAA,MAAA,GAAS,MAAM,QAAA,CAAS,IAAK,EAAA,CAAA;AAEnC,MAAA,IAAI,SAAS,GAAK,EAAA;AAChB,QAAA,MAAM,IAAI,UAAA,CAAW,CAAwB,qBAAA,EAAA,MAAM,OAAO,MAAQ,CAAA,CAAA,CAAA,CAAA;AAAA,OACpE;AAEA,MAAI,GAAA,CAAA,MAAA,CAAO,IAAM,EAAA,MAAA,CAAO,EAAE,CAAA,CAAA;AAC1B,MAAI,GAAA,CAAA,MAAA,CAAO,UAAU,MAAM,CAAA,CAAA;AAAA,KAC7B;AAAA,GACD,CAAA,CAAA;AACH;;;;"}

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@backstage/plugin-scaffolder-backend-module-sentry",
+  "version": "0.0.0-nightly-20230112022659",
+  "main": "dist/index.esm.js",
+  "types": "dist/index.d.ts",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "frontend-plugin"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/config": "^0.0.0-nightly-20230112022659",
+    "@backstage/errors": "^1.1.4",
+    "@backstage/integration": "^0.0.0-nightly-20230112022659",
+    "@backstage/plugin-scaffolder-backend": "^0.0.0-nightly-20230112022659"
+  },
+  "peerDependencies": {
+    "react": "^16.13.1 || ^17.0.0"
+  },
+  "devDependencies": {
+    "@backstage/cli": "^0.0.0-nightly-20230112022659",
+    "@backstage/core-app-api": "^0.0.0-nightly-20230112022659",
+    "@backstage/dev-utils": "^0.0.0-nightly-20230112022659",
+    "@backstage/test-utils": "^0.0.0-nightly-20230112022659",
+    "@testing-library/jest-dom": "^5.10.1",
+    "@testing-library/react": "^12.1.3",
+    "@testing-library/user-event": "^14.0.0",
+    "@types/node": "*",
+    "cross-fetch": "^3.1.5",
+    "msw": "^0.49.0"
+  },
+  "files": [
+    "dist"
+  ]
+}