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

Coder plugin: Make Coder SDK available to Backstage users #114

Closed
Tracked by #16
Parkreiner opened this issue Apr 15, 2024 · 0 comments · Fixed by #131
Closed
Tracked by #16

Coder plugin: Make Coder SDK available to Backstage users #114

Parkreiner opened this issue Apr 15, 2024 · 0 comments · Fixed by #131
Assignees
Labels
enhancement New feature or request

Comments

@Parkreiner
Copy link
Collaborator

Parkreiner commented Apr 15, 2024

Part of #16

Update: After discussing with the team, we've decided the best approach is to use a postinstall script to convert api.ts from TS to JS using Bun or similar. This will alleviate concerns about drift, release, and breaking changes. In addition, we will need to update our Axios instance to avoid collisions - an update which is documented in this ticket.

Another Update: going with a vendored approach as per discussion here.

What we need

Should haves

  • The user should have the ability to bring the Coder SDK in directly, and make API calls for any officially-supported Coder endpoint

Not necessary

Known challenges

  • Right now, we technically don't have a Coder SDK – so far, we've been directly importing the main Coder codebase into other projects, and consuming its files
    • One problem with this approach is that you need access to your build process tool's configuration file (whether that's Webpack or Vite). You need to be able to tell it that it that the files in the Coder import are not pre-compiled, and need to be processed.
    • However, Backstage locks their Webpack config file down, and does not let you modify it to avoid drift in major versions. Realistically, we may need to make a dedicated SDK
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant