{"id":48489305,"url":"https://github.com/stuttgart-things/sthings-backstage","last_synced_at":"2026-05-22T09:05:35.570Z","repository":{"id":334072230,"uuid":"1139838050","full_name":"stuttgart-things/sthings-backstage","owner":"stuttgart-things","description":"suttgart-things backstage app","archived":false,"fork":false,"pushed_at":"2026-04-07T09:59:53.000Z","size":3009,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-04-07T11:33:39.033Z","etag":null,"topics":["backstage","idp-platform","platform-engineering","portal"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stuttgart-things.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-22T13:37:44.000Z","updated_at":"2026-04-07T09:59:59.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/stuttgart-things/sthings-backstage","commit_stats":null,"previous_names":["stuttgart-things/sthings-backstage"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/stuttgart-things/sthings-backstage","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fsthings-backstage","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fsthings-backstage/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fsthings-backstage/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fsthings-backstage/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stuttgart-things","download_url":"https://codeload.github.com/stuttgart-things/sthings-backstage/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stuttgart-things%2Fsthings-backstage/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31707954,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-12T06:22:27.080Z","status":"ssl_error","status_checked_at":"2026-04-12T06:21:52.710Z","response_time":58,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backstage","idp-platform","platform-engineering","portal"],"created_at":"2026-04-07T11:03:12.483Z","updated_at":"2026-04-12T08:06:01.292Z","avatar_url":"https://github.com/stuttgart-things.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sthings-backstage\n\n\n\u003cdiv align=\"center\"\u003e\n  \u003cp\u003e\n    \u003cimg src=\"https://github.com/stuttgart-things/docs/blob/main/hugo/sthings-backstage.jpg\" alt=\"sthings\" width=\"450\" /\u003e\n  \u003c/p\u003e\n  \u003cp\u003e\n    \u003cstrong\u003e[An Internal Developer Portal]\u003c/strong\u003e - built on Backstage for stuttgart-things.\n\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n## Overview\n\nsthings-backstage provides a centralized platform for managing software development across the organization, featuring:\n\n- **Software Catalog** - Centralized registry for services and components\n- **TechDocs** - Technical documentation managed as code\n- **Software Templates** - Scaffolding system for creating new projects\n- **Kubernetes Integration** - Visibility and management of Kubernetes clusters\n- **GitHub Integration** - Authentication, catalog import, and scaffolder actions\n- **GitHub Scaffolder Module** - Extended GitHub actions for software templates\n- **Claim Machinery Plugin** - Integration with Claim Machinery API for dynamic claim templates\n- **Claim Registry Plugin** - Scaffolder extensions for browsing and deleting claims via GitHub PRs\n- **YAML Utils Module** - Scaffolder action for parsing workspace YAML files in template workflows\n- **GitHub Actions Plugin** - CI/CD visibility for GitHub Actions workflow runs on entity pages\n- **Unified Search** - Cross-entity search functionality\n\n## Getting Started\n\n**Prerequisites:** Node.js 22 or 24, Yarn 4.13.0\n\n```sh\nyarn install\nyarn dev\n```\n\nThis starts the frontend on port 3000 and backend on port 7007.\n\n## Project Structure\n\n```\nsthings-backstage/\n├── packages/app/       # Frontend React application\n├── packages/backend/   # Backend Node.js API\n├── plugins/            # Custom plugins directory\n├── app-config.yaml     # Main configuration\n└── catalog-info.yaml   # Catalog entity definitions\n```\n\n## Tasks\n\nThis project uses [Task](https://taskfile.dev) for automation. Run `task --list` to see all available tasks.\n\n| Task | Description |\n|------|-------------|\n| `task dev` | Start Backstage in development mode with .env loaded |\n| `task build-push-scan-image` | Build, push, and scan container image using Dagger |\n| `task do` | Interactive task selector (requires gum) |\n\n**Included task modules:**\n\n| Prefix | Source |\n|--------|--------|\n| `init:` | Backstage initialization tasks |\n| `git:` | Git operations |\n| `docker:` | Docker build tasks |\n| `trivy:` | Container security scanning |\n\n## Documentation\n\nSee the [docs](docs/) folder for detailed documentation:\n\n- [Configuration](docs/configuration.md) - Environment variables and secrets\n- [GitHub Integration](docs/github-integration.md) - OAuth and API setup\n- [GitHub Scaffolder Module](docs/github-scaffolder-module.md) - Extended GitHub actions for templates\n- [Scaffolding](docs/scaffolding.md) - Project templates and structure\n- [Claim Machinery Plugin](docs/claim-machinery-plugin.md) - Installation and configuration guide\n- [Claim Registry Plugin](docs/claim-registry-plugin.md) - Claim browsing and deletion via GitHub PRs\n- [YAML Utils Module](docs/yaml-utils-module.md) - Scaffolder action for parsing YAML files\n- [GitHub Actions Plugin](docs/github-actions-plugin.md) - CI/CD workflow visibility on entity pages\n\n## Claim Machinery Plugin\n\nThis instance includes the `backstage-claim-machinery-plugin` which provides custom scaffolder extensions for rendering Kubernetes claim manifests via the Claim Machinery API.\n\n### Components\n\n| Component | Location | Purpose |\n|-----------|----------|---------|\n| Backend Action | `packages/backend/src/plugins/scaffolder-claim-machinery/` | `claim-machinery:render` scaffolder action |\n| Field Extensions | `packages/app/src/scaffolder/` | `ClaimMachineryPicker` and `ClaimMachineryParameters` UI components |\n\n### Configuration\n\n```yaml\n# app-config.yaml\nclaimMachinery:\n  apiUrl: ${CLAIM_MACHINERY_API_URL}\n\nproxy:\n  endpoints:\n    '/claim-machinery':\n      target: ${CLAIM_MACHINERY_API_URL}\n      changeOrigin: true\n```\n\n### Environment Variables\n\n| Variable | Description |\n|----------|-------------|\n| `CLAIM_MACHINERY_API_URL` | URL of the Claim Machinery API |\n\nFor complete installation and usage details, see the [Claim Machinery Plugin documentation](docs/claim-machinery-plugin.md).\n\n## Claim Registry Plugin\n\nThis instance includes the `backstage-claim-registry-plugin` which provides a scaffolder field extension for browsing claims from the Machinery Registry API and a backend action for deleting claims via GitHub pull requests.\n\n### Components\n\n| Component | Location | Purpose |\n|-----------|----------|---------|\n| Backend Action | `packages/backend/src/plugins/scaffolder-claim-registry/` | `claim-registry:delete` scaffolder action |\n| Field Extension | `packages/app/src/scaffolder/` | `RegistryClaimPicker` UI component |\n\n### Configuration\n\n```yaml\n# app-config.yaml\nproxy:\n  endpoints:\n    '/machinery-registry':\n      target: ${CLAIM_MACHINERY_API_URL}\n      changeOrigin: true\n```\n\n### Environment Variables\n\n| Variable | Description |\n|----------|-------------|\n| `CLAIM_MACHINERY_API_URL` | URL of the Machinery Registry API |\n| `GITHUB_TOKEN` | GitHub PAT for creating deletion PRs |\n\nFor complete installation and usage details, see the [Claim Registry Plugin documentation](docs/claim-registry-plugin.md).\n\n## YAML Utils Module\n\nThe `utils:yaml:parse` scaffolder action reads and parses YAML files from the scaffolder workspace. This enables append-mode templates that fetch existing configuration from a repository, merge new entries, and create a PR with the combined result.\n\n### Components\n\n| Component | Location | Purpose |\n|-----------|----------|---------|\n| Backend Action | `packages/backend/src/plugins/scaffolder-yaml-utils/` | `utils:yaml:parse` scaffolder action |\n\n### Key Features\n\n- Reads YAML files from the scaffolder workspace and outputs parsed content\n- Graceful error handling: returns `{}` for missing or invalid files\n- Designed for use with `fetch:plain` to enable merge/append workflows\n\nFor complete details, see the [YAML Utils Module documentation](docs/yaml-utils-module.md).\n\n## GitHub Actions Plugin\n\nThe CI/CD tab on service and website entity pages displays GitHub Actions workflow runs for the associated repository.\n\n### Components\n\n| Component | Location | Purpose |\n|-----------|----------|---------|\n| Frontend Plugin | `@backstage-community/plugin-github-actions` | `EntityGithubActionsContent` on CI/CD tab |\n| Entity Page Integration | `packages/app/src/components/catalog/EntityPage.tsx` | Conditional rendering via `isGithubActionsAvailable` |\n\n### Required Annotation\n\nCatalog entities must have the `github.com/project-slug` annotation to enable the CI/CD tab:\n\n```yaml\nmetadata:\n  annotations:\n    github.com/project-slug: 'org/repo-name'\n```\n\nFor complete details, see the [GitHub Actions Plugin documentation](docs/github-actions-plugin.md).\n\n## Known Upgrade Constraints\n\n### React 19\n\nReact 19 upgrade is **blocked** by upstream Backstage dependencies (as of April 2026). Key blockers:\n\n| Dependency | Issue | Status |\n|-----------|-------|--------|\n| `@material-ui/core` (MUI v4) | Uses `ReactDOM.findDOMNode()`, removed in React 19 | Waiting on Backstage MUI v5 migration |\n| `@graphiql/react@0.29.0` | Uses `unmountComponentAtNode`, removed in React 19. Newer versions (0.37+) have breaking API changes incompatible with `@backstage/plugin-api-docs` | Waiting on `@backstage/plugin-api-docs` update |\n| `react-markdown@8.0.7` | TypeScript type errors with `@types/react@19` | Fixable via resolution to `^10.1.0`, but moot given the above |\n\n**Action:** Revisit once Backstage officially supports React 19 and completes the MUI v5 migration. Track progress in the [Backstage MUI v5 migration issue](https://github.com/backstage/backstage/issues/20447).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuttgart-things%2Fsthings-backstage","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstuttgart-things%2Fsthings-backstage","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstuttgart-things%2Fsthings-backstage/lists"}