backstage_scaffolder_custom_action_log_message_quickstart.ts

1import { createTemplateAction } from '@backstage/plugin-scaffolder-node';
2
3/**
4 * This is the official quickstart example for creating a custom action
5 * for the Backstage Scaffolder.
6 */
7export const createLogAction = () => {
8  return createTemplateAction<{ message: string }>({
9    id: 'my-company:log',
10    schema: {
11      input: {
12        type: 'object',
13        required: ['message'],
14        properties: {
15          message: {
16            title: 'Message',
17            description: 'The message to log to the console',
18            type: 'string',
19          },
20        },
21      },
22    },
23    async handler(ctx) {
24      ctx.logger.info(`Action is running with message: ${ctx.input.message}`);
25    },
26  });
27};