Skip to content

Commit

Permalink
Merge pull request #6 from arhill05/features/new-backend
Browse files Browse the repository at this point in the history
Migrate to new Backstage backend system
  • Loading branch information
arhill05 authored May 29, 2024
2 parents f113dc7 + 4a8ca5b commit 347f71a
Show file tree
Hide file tree
Showing 7 changed files with 4,071 additions and 1,963 deletions.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
node_modules
dist/**
dist-types/**
dist-types/**
32 changes: 4 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,40 +39,16 @@ yarn add --cwd packages/backend @mdude2314/backstage-plugin-scaffolder-backend-m
Add the actions you'd like to the scaffolder:

```typescript
// packages/backend/src/plugins/scaffolder.ts
// packages/backend/src/index.ts

import {
createSendSlackMessageViaWebhookAction,
createSendSlackMessageViaSlackApiAction
sendSlackMessageModule
} from '@mdude2314/backstage-plugin-scaffolder-backend-module-slack'

import { ScmIntegrations } from '@backstage/integration';
import { createBuiltinActions, createRouter } from '@backstage/plugin-scaffolder-backend';

...

const integrations = ScmIntegrations.fromConfig(env.config);
const builtInActions = createBuiltinActions({
catalogClient,
integrations,
config: env.config,
reader: env.reader
});

const actions = [
createSendSlackMessageViaWebhookAction({ config: env.config }),
createSendSlackMessageViaSlackApiAction({ config: env.config })
...builtInActions
];

return await createRouter({
logger: env.logger,
config: env.config,
database: env.database,
reader: env.reader,
catalogClient,
actions
});
backend.add(sendSlackMessageModule());

```

Add a Slack configuration section to your app-config.yaml.
Expand Down
3 changes: 3 additions & 0 deletions backstage.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
{
"version": "1.27.5"
}
20 changes: 11 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@mdude2314/backstage-plugin-scaffolder-backend-module-slack",
"description": "The slack module for @backstage/plugin-scaffolder-backend",
"version": "2.0.0",
"version": "3.0.0",
"main": "src/index.ts",
"types": "src/index.ts",
"license": "Apache-2.0",
Expand All @@ -28,16 +28,18 @@
"postpack": "backstage-cli package postpack"
},
"dependencies": {
"@backstage/config": "^1.0.8",
"@backstage/errors": "^1.2.1",
"@backstage/plugin-scaffolder-backend": "^1.3.0",
"@backstage/plugin-scaffolder-node": "^0.1.5",
"@slack/web-api": "^6.10.0",
"axios": "^1.6.0"
"@backstage/backend-plugin-api": "^0.6.18",
"@backstage/config": "^1.2.0",
"@backstage/errors": "^1.2.4",
"@backstage/integration": "^1.11.0",
"@backstage/plugin-scaffolder-backend": "^1.22.7",
"@backstage/plugin-scaffolder-node": "^0.4.4",
"@slack/web-api": "^7.0.4",
"axios": "^1.4.0"
},
"devDependencies": {
"@backstage/backend-common": "^0.18.3",
"@backstage/cli": "^0.22.7",
"@backstage/backend-common": "^0.22.0",
"@backstage/cli": "^0.26.6",
"winston": "^3.10.0"
},
"files": [
Expand Down
3 changes: 2 additions & 1 deletion src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,5 @@
* @packageDocumentation
*/

export * from './actions';
export * from "./actions";
export { scaffolderModuleSendSlackMessage as default } from "./module";
28 changes: 28 additions & 0 deletions src/module.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import {
coreServices,
createBackendModule,
} from "@backstage/backend-plugin-api";
import { scaffolderActionsExtensionPoint } from "@backstage/plugin-scaffolder-node/alpha";
import {
createSendSlackMessageViaWebhookAction,
createSendSlackMessageViaSlackApiAction,
} from "./actions";

export const scaffolderModuleSendSlackMessage = createBackendModule({
pluginId: "scaffolder",
moduleId: "slack",
register({ registerInit }) {
registerInit({
deps: {
scaffolder: scaffolderActionsExtensionPoint,
config: coreServices.rootConfig,
},
async init({ scaffolder, config }) {
scaffolder.addActions(
createSendSlackMessageViaWebhookAction({ config }),
createSendSlackMessageViaSlackApiAction({ config })
);
},
});
},
});
Loading

0 comments on commit 347f71a

Please sign in to comment.