new backend for scaffolder-backend-argocd

.changeset/healthy-rivers-sing.md

@@ -0,0 +1,5 @@
+---
+'@roadiehq/scaffolder-backend-argocd': minor
+---
+
+Update to new backend system

plugins/scaffolder-actions/scaffolder-backend-argocd/README.md

@@ -52,11 +52,33 @@ return await createRouter({
 });
 ```
 
+### New backend system
+
+## From your Backstage root directory
+
+```
+cd packages/backend
+yarn add @roadiehq/scaffolder-backend-argocd
+```
+
+```typescript
+// packages/backend/src/index.ts
+import { createBackend } from '@backstage/backend-defaults';
+import { createBackendModule } from '@backstage/backend-plugin-api';
+
+const backend = createBackend();
+backend.add(import('@backstage/plugin-scaffolder-backend/alpha'));
+backend.add(
+  import('@roadiehq/scaffolder-backend-argocd/new-backend'),
+);
+backend.start();
+
 ### From your software template yaml file
 
 Under `spec.steps[]` insert the below. In the below we reference items in the `spec.paramters[]` section.
 
 ```
+
     - id: create-argocd-resources
       name: Create ArgoCD Resources
       action: argocd:create-resources
@@ -67,6 +89,7 @@ Under `spec.steps[]` insert the below. In the below we reference items in the `s
         repoUrl: ${{ steps.publish.output.remoteUrl }}
         labelValue: ${{ parameters.name }}
         path: "kubernetes/nonprod"
+
 ```
 
 > If needed there is an optional parameter of `projectName` as well.
@@ -76,3 +99,4 @@ Under `spec.steps[]` insert the below. In the below we reference items in the `s
 ---
 
 Roadie gives you a hassle-free, fully customisable SaaS Backstage. Find out more here: [https://roadie.io](https://roadie.io).
+```

plugins/scaffolder-actions/scaffolder-backend-argocd/package.json

@@ -14,6 +14,21 @@
     "pluginId": "scaffolder-backend-argocd",
     "pluginPackage": "@backstage/plugin-scaffolder-backend"
   },
+  "exports": {
+    ".": "./src/index.ts",
+    "./package.json": "./package.json",
+    "./new-backend": "./src/new-backend.ts"
+  },
+  "typesVersions": {
+    "*": {
+      "package.json": [
+        "package.json"
+      ],
+      "new-backend": [
+        "src/new-backend.ts"
+      ]
+    }
+  },
   "repository": {
     "type": "git",
     "url": "github:RoadieHQ/roadie-backstage-plugins",
@@ -34,8 +49,10 @@
   },
   "dependencies": {
     "@backstage/backend-common": "^0.24.0",
+    "@backstage/backend-plugin-api": "^0.8.0",
     "@backstage/config": "^1.2.0",
     "@backstage/plugin-scaffolder-backend": "^1.24.0",
+    "@backstage/plugin-scaffolder-node": "^0.4.9",
     "@roadiehq/backstage-plugin-argo-cd-backend": "^3.2.2",
     "@backstage/backend-test-utils": "^0.5.0",
     "winston": "^3.2.1"

plugins/scaffolder-actions/scaffolder-backend-argocd/src/index.ts

@@ -14,3 +14,4 @@
  * limitations under the License.
  */
 export * from './actions';
+export * from './new-backend';

plugins/scaffolder-actions/scaffolder-backend-argocd/src/module.ts

@@ -0,0 +1,48 @@
+/*
+ * Copyright 2024 Larder Software Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import {
+  createBackendModule,
+  coreServices,
+} from '@backstage/backend-plugin-api';
+import { scaffolderActionsExtensionPoint } from '@backstage/plugin-scaffolder-node/alpha';
+import { loggerToWinstonLogger } from '@backstage/backend-common';
+import * as backendModuleUtils from './actions';
+
+/**
+ * @public
+ * The Roadie Module for the Scaffolder Backend ArgoCD Actions
+ */
+export const scaffolderBackendArgoCD = createBackendModule({
+  pluginId: 'scaffolder',
+  moduleId: 'scaffolder-backend-argocd',
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        scaffolder: scaffolderActionsExtensionPoint,
+        config: coreServices.rootConfig,
+        logger: coreServices.logger,
+      },
+      async init({ scaffolder, config, logger }) {
+        scaffolder.addActions(
+          backendModuleUtils.createArgoCdResources(
+            config,
+            loggerToWinstonLogger(logger),
+          ),
+        );
+      },
+    });
+  },
+});

plugins/scaffolder-actions/scaffolder-backend-argocd/src/new-backend.ts

@@ -0,0 +1,16 @@
+/*
+ * Copyright 2024 Larder Software Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export { scaffolderBackendArgoCD as default } from './module';