https://github.com/gitpod-samples/gitpod-backstage-plugin
Backstage plugin for Gitpod
https://github.com/gitpod-samples/gitpod-backstage-plugin
Last synced: 3 months ago
JSON representation
Backstage plugin for Gitpod
- Host: GitHub
- URL: https://github.com/gitpod-samples/gitpod-backstage-plugin
- Owner: gitpod-samples
- Created: 2024-03-11T15:14:20.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-22T18:00:58.000Z (11 months ago)
- Last Synced: 2025-03-24T12:56:22.428Z (3 months ago)
- Language: TypeScript
- Homepage: https://www.gitpod.io
- Size: 756 KB
- Stars: 0
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Gitpod Backstage Plugin
The Gitpod Backstage Plugin is the official integration of Gitpod's cloud development environments into Spotify's Backstage.
It enables developers to start workspaces directly from their Backstage instance. This plugin aims to streamline the development workflow, providing teams with easy access and efficient management of their cloud development environments.
## Getting started
To get started with the Gitpod plugin in your Backstage app, follow these steps:
1. **Install the plugin**:
```bash
# From your Backstage root directory
yarn add --cwd packages/app @gitpod/backstage-plugin-gitpod
```
2. **Add the Gitpod component to a page in your app:**
For instance, add it to `overviewContent` in `EntityPage.tsx`:
```jsx
import { GitpodButton } from '@gitpod/backstage-plugin-gitpod';
//....
const HomePage = () => (
// ...
// ...
);
```
3. **Setup entity annotations**:
Currently, the Gitpod Backstage plugin support importing the URL of the repository from the following [entity annotations](https://backstage.io/docs/features/software-catalog/descriptor-format#annotations-optional):
- `github.com/project-slug`
- `gitlab.com/project-slug`
- `bitbucket.org/project-slug`
- `repo-url` (for any repository defined by its full URL)
4. **Configure the Gitpod URL**:
Add your Gitpod URL to your `app-config.yaml` - this can either be Gitpod Cloud or Dedicated.
```yaml
gitpod:
baseUrl: 'https://gitpod.io'
```
## Contributing
We welcome contributions to the Gitpod Backstage plugin! If you have any feature requests or would like to raise a pull request, please feel free to leave an issue.
## Links
- [Gitpod](https://www.gitpod.io)
- [Internal Developer Portals and Gitpod](https://www.gitpod.io/docs/integrations/internal-developer-portals)
- [Backstage](https://backstage.io)
- [Learn more about Backstage plugins](https://backstage.io/docs/plugins/)