Skip to content

coder/backstage-plugins

Repository files navigation

Official Coder plugins for Backstage

Backstage Plugins

A collection of plugins that extend Backstage to help with developer onboarding, context switching, and automated IDEs (remote or local).

  • backstage-plugin-coder: A plugin for integrating Coder workspaces with Backstage.
  • backstage-plugin-devcontainers-backend: A plugin for integrating VS Code Dev Containers extension with Backstage catalog items (no Coder deployment necessary).
  • backstage-plugin-devcontainers-react: A plugin for allowing you to detect and work with Dev Containers repo data added by backstage-plugin-devcontainers-backend, namely letting you open a repo in VS Code with a full Dev Containers setup (no Coder deployment necessary).

Please use GitHub issues to report any issues or feature requests.

Contributing

To start the app:

yarn install
yarn dev

To run an individual plugin:

cd plugins/backstage-plugin-$name
yarn install
yarn start

Note that the Coder plugin does not support running like this as it currently uses a backend proxy that is not available when running independently of the Backstage app.

Releasing

To draft a release for a plugin push a tag named $name/v$version without the backstage-plugin- prefix. For example:

git tag -a coder/v0.0.0 -m "coder v0.0.0"
git push origin coder/v0.0.0

This will kick off an action that will create a draft release for the plugin. Once you have reviewed the release you can publish it and another action will publish the plugin to NPM.

Support

Feel free to open an issue if you have questions, run into bugs, or have a feature request.

Join our Discord to provide feedback on in-progress features, and chat with the community!

As always, you can also join the official Backstage Discord to stay involved in their wonderful community.