Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Changes copilot backend plugin name to make backend installation work #1846

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions workspaces/copilot/.changeset/few-rocks-call.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@backstage-community/plugin-copilot-backend': patch
---

Fixed package reference in backend installation instructions.
7 changes: 6 additions & 1 deletion workspaces/copilot/plugins/copilot-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,15 @@ To configure the plugin using the new backend system:

const backend = createBackend();

backend.add(import('@backstage-community/plugin-copilot'));
backend.add(import('@backstage-community/plugin-copilot-backend'));
christoph-jerolimov marked this conversation as resolved.
Show resolved Hide resolved
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we are here we could make it a diff :D

  import { createBackend } from '@backstage/backend-defaults';

  const backend = createBackend();

+ backend.add(import('@backstage-community/plugin-copilot-backend'));

  backend.start();


backend.start();
```
2. Add the package as a dependency in the backend workspace

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could this be Step 1 so that it is consistent with the "Old system" instructions?

The wording could also be made consistent i.e.

"Add the @backstage-community/plugin-copilot-backend package to your backend:"


```sh
yarn --cwd packages/backend add @backstage-community/plugin-copilot-backend
```

### Old System

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can the "old system" instructions also be updated to reference @backstage-community/plugin-copilot-backend?

Expand Down
Loading