PagerDuty / backstage-plugin-backend

PagerDuty plugin for Backstage - Backend
https://pagerduty.github.io/backstage-plugin-docs/index.html
Apache License 2.0
3 stars 6 forks source link

release: 0.6.0 #55

Closed t1agob closed 4 months ago

t1agob commented 4 months ago

Description

This release adds support to the new Backstage backend system without forcing users to move to the new backend system if they choose to stay in the legacy backend system for now.

Warning: Existing backend plugin users need to make some changes in code because we had to extract the Scaffolder actions to a separate Backstage module (@pagerduty/backstage-plugin-scaffolder-actions).

For existing users using the legacy backend system

  1. Install new package

    yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
    yarn install
  2. Update your existing reference in packages/backend/src/plugins/scaffolder.ts from the backend component to the new one

    import { createPagerDutyServiceAction } from '@pagerduty/backstage-plugin-scaffolder-actions';
  3. Pass the environment config and logger to createPagerDutyServiceAction

    
      const actions = [
         ...builtInActions, 
         createPagerDutyServiceAction({ 
              config: env.config, 
              logger: env.logger 
         })
      ];```

For users using the new backend system

  1. Install new package

    yarn add --cwd packages/backend @pagerduty/backstage-plugin-scaffolder-actions
    yarn install
  2. (Optional) If this is the first time configuring PagerDuty's plugin you also need the following packages

    yarn add --cwd packages/backend @pagerduty/backstage-plugin-backend @pagerduty/backstage-plugin-common
    yarn install
  3. Add the package to your backend in packages/backend/src/index.ts

    
    // PagerDuty backend plugin
    backend.add(import('@pagerduty/backstage-plugin-backend'));
    
    // PagerDuty Scaffolder Actions Module
    backend.add(import('@pagerduty/backstage-plugin-scaffolder-actions'));

Acknowledgement

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.