Merge branch 'master' into fix/displayNameSearch

This commit is contained in:
Julien
2024-11-18 09:04:48 +01:00
821 changed files with 23998 additions and 6237 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Fixed an issue where the `--successCache` option for the `repo test` and `repo lint` commands would be include the workspace path in generated cache keys. This previously broke caching in environments where the workspace path varies across builds.
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/plugin-catalog': minor
---
- Updated EntityLayout component to implement breadcrumb navigation based on the entity relations.
- Added parentEntityRelations prop to EntityLayoutProps to specify relation types for parent entities.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-api-docs': minor
---
Added support for pagination in api-docs plugin - DefaultApiExplorerPage
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/catalog-client': minor
---
Internal update to use the updated generated code from `backstage-cli package schema openapi generate --client-package ...`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Fix dev server reloads of plugin discovery for new frontend system.
+10
View File
@@ -0,0 +1,10 @@
---
'@backstage/backend-dynamic-feature-service': minor
---
**BREAKING** The `dynamicPluginsFeatureLoader` options related to the root logger behavior (`transports`, `level`, `format`) are now gathered under a single `logger` option which is a function taking an optional `Config` argument and returning the logger options.
This breaking change is required for 2 reasons:
- it's totally possible that the current `Config` would be required to provide the logger options,
- the logger-related options should be gathered under a common `logger` option because, when the root auditing service is introduced, distinct but similarly-named options would be required for the auditor as well.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/create-app': patch
---
Bumped create-app version.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/theme': patch
---
Internal refactor to avoid top-level imports from MUI.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog': patch
---
Fixed an issue causing the `CatalogIndexPage` to not properly filter results when using offset pagination.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-auth-backend-module-google-provider': patch
---
Fix visibility of config for use in front end code
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/types': minor
---
Introduce `createDeferred` and `DeferredPromise`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': minor
---
**BREAKING**: Updates ESLint config to ignore all generated source code under `src/**/generated/**/*.ts`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/integration-aws-node': patch
---
The `getDefaultCredentialsChain` function now accepts and applies a `region` parameter, preventing it from defaulting to `us-east-1` when no region is specified.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-search': patch
---
Removes the card UI from the search results type filter for a cleaner UI consistent with other filters
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/backend-dynamic-feature-service': patch
---
Enhance the `CommonJSModuleLoader` to add support for `resolvePackagePath` calls from backend dynamic plugins, with customizable package resolution, and make the `CommonJSModuleLoader` public API.
Fixing this backend dynamic plugin limitation related to `resolvePackagePath` is important for backend dynamic plugins which use the database, since database migration scripts systematically use `resolvePackagePath`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-kubernetes-react': patch
---
add the pod delete feature to the kubernetes react plugin
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-catalog-backend': minor
'@backstage/plugin-search-backend': minor
---
Internal update to use the new generated server types from `backstage-cli package schema openapi generate --server`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-ldap': minor
---
Add Support for Google LDAP Vendor
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs': patch
---
Fix an issue with index page of documentation site being re-rendered.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend-module-gitlab': patch
---
Improve error messages from Gitlab
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-notifications': patch
---
Added title to the Notifications' table. The title clearly states the filter selection and total count of messages. This change aligns the look and feel closer to other tables.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-notifications': patch
---
The "Created after" filter renamed to the "Sent out" based on the received users' feedback.
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/plugin-scaffolder-common': patch
'@backstage/plugin-scaffolder-react': patch
'@backstage/plugin-scaffolder': minor
---
Add scaffolder permission `scaffolder.template.management` for accessing the template management features
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-test-utils': minor
---
Made it possible to construct `mockServices.database` with a given knex instance
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Add `--max-warnings -1` support to `backstage-cli package lint`
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-import': patch
---
Fixed parsing of catalog-info.yaml when creating a PR to register a repository if the file contains more than one document
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/core-components': patch
---
Change core component Table tool bar search box to the a appropriate Search icon and text
+9
View File
@@ -0,0 +1,9 @@
---
'@backstage/cli': minor
---
Added a new optimization to the `repo test` command that will filter out unused packages in watch mode if all provide filters are paths that point from the repo root. This significantly speeds up running individual tests from the repo root in a large workspace, for example:
```sh
yarn test packages/app/src/App.test.tsx
```
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch
'@backstage/plugin-scaffolder-backend': patch
'@backstage/config-loader': patch
---
Internal refactor to use the deferred from the types package
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-react': patch
---
Ensure EntityDisplayName component link receives underline on hover.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/repo-tools': patch
---
The `generate-patch` command now properly includes newly created files in the patch.
+9
View File
@@ -0,0 +1,9 @@
---
'@backstage/plugin-kubernetes-backend': minor
'@backstage/plugin-kubernetes-common': minor
'@backstage/plugin-kubernetes-react': minor
'@backstage/plugin-kubernetes-node': minor
'@backstage/plugin-kubernetes': minor
---
Bumping @kubernetes/client-node to 1.0.0-rc7 to mitigate CVEs related to the request and tough-cookie packages
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-react': patch
---
Improve UI consistency of default catalog filters
+66 -1
View File
@@ -1,5 +1,5 @@
{
"mode": "pre",
"mode": "exit",
"tag": "next",
"initialVersions": {
"example-app": "0.2.102",
@@ -195,51 +195,116 @@
"@backstage/plugin-user-settings-common": "0.0.1"
},
"changesets": [
"afraid-bananas-behave",
"afraid-carrots-greet",
"big-tips-heal",
"bright-buckets-laugh",
"bright-singers-do",
"chilled-taxis-dance",
"create-app-1729608704",
"create-app-1730809984",
"curvy-bears-nail",
"cyan-trees-bow",
"early-cobras-compare",
"early-monkeys-hammer",
"empty-lobsters-wait",
"few-hornets-rush",
"flat-feet-do",
"forty-pets-wave",
"forty-spoons-burn",
"fresh-jeans-relate",
"friendly-hats-push",
"friendly-kids-judge",
"friendly-melons-shake",
"green-tools-arrive",
"grumpy-shoes-return",
"healthy-bags-jog",
"healthy-lions-judge",
"healthy-tables-wonder",
"heavy-mice-raise",
"heavy-phones-shave",
"hungry-cats-juggle",
"hungry-owls-sell",
"itchy-elephants-trade",
"khaki-fireants-march",
"late-kings-wave",
"lemon-gifts-crash",
"little-rivers-deny",
"loud-plants-dream",
"loud-trainers-yawn",
"lucky-bananas-eat",
"lucky-snakes-complain",
"mean-years-deliver",
"metal-files-itch",
"mighty-jobs-unite",
"mighty-spoons-suffer",
"neat-buttons-wait",
"ninety-panthers-provide",
"ninety-shirts-float",
"orange-moles-taste",
"perfect-goats-mate",
"pink-schools-shave",
"plenty-students-check",
"pretty-zebras-listen",
"purple-masks-swim",
"quick-cougars-fry",
"rare-otters-judge",
"rare-trains-scream",
"red-fishes-press",
"renovate-3d822ce",
"renovate-4635182",
"renovate-6193787",
"renovate-7a33477",
"renovate-7b59eed",
"renovate-b2c2aaf",
"renovate-bcc9782",
"rotten-lions-cover",
"rotten-needles-relax",
"selfish-ads-count",
"selfish-spies-cough",
"serious-penguins-remain",
"seven-berries-listen",
"seven-hotels-move",
"shiny-falcons-fly",
"short-geckos-sniff",
"short-pots-remember",
"shy-clouds-brake",
"shy-pots-speak",
"shy-rats-hear",
"silent-wasps-whisper",
"silly-kiwis-destroy",
"silver-ears-grin",
"silver-kings-sort",
"six-beds-exercise",
"slimy-jobs-scream",
"slimy-penguins-care",
"slow-mayflies-sleep",
"slow-shrimps-call",
"smart-bags-sell",
"soft-turkeys-tie",
"spotty-snails-worry",
"strange-clocks-pretend",
"strong-paws-change",
"swift-laws-applaud",
"ten-hats-appear",
"ten-pears-unite",
"tender-feet-scream",
"thick-trees-worry",
"three-mangos-dance",
"tough-onions-dance",
"tricky-crabs-lick",
"twelve-masks-call",
"two-donuts-float",
"unlucky-countries-shop",
"violet-ears-dance",
"violet-parrots-knock",
"warm-tomatoes-develop",
"wild-experts-unite",
"wise-avocados-behave",
"wise-snakes-sleep",
"witty-bobcats-push",
"witty-socks-repeat",
"yellow-horses-pretend",
"young-penguins-act"
]
}
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-notifications': patch
---
The notification's title is emphasized to be clearly distinguished from the description.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-kubernetes-backend': patch
---
Adapted the config.d.ts for custom k8s cluster authProvider implementations
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Updated dependency `vite` to `^5.0.0`.
+7
View File
@@ -0,0 +1,7 @@
---
'@backstage/cli': patch
'@backstage/repo-tools': patch
'@backstage/plugin-bitbucket-cloud-common': patch
---
Updated dependency `ts-morph` to `^24.0.0`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Updated dependency `css-loader` to `^7.0.0`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Updated dependency `@module-federation/enhanced` to `^0.7.0`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder': patch
---
Updated dependency `idb-keyval` to `5.1.5`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-openapi': patch
---
Updated dependency `@apidevtools/json-schema-ref-parser` to `^11.0.0`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-github': patch
---
Fixed an issue in `GithubOrgEntityProvider` that caused an error when processing teams without a parent.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/create-app': patch
---
This update adds the @backstage/repo-tools package to the versions.ts file, enabling proper version resolution for templates. The {{version '@backstage/repo-tools'}} placeholder now works as expected in the create-app process.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend-module-gitlab': patch
---
Removed circular import
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-defaults': patch
---
Disabling database migrations now correctly uses the `backend.default.skipMigrations` config value.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog': minor
---
Allow `OffsetPaginatedCatalogTable` to configure Table options and `CursorPaginatedCatalogTable` to configure `paginationPosition`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': minor
---
The package packing now populates `typesVersions` for additional entry points rather than using additional `package.json` files for type resolution. This improves auto completion of separate entry points when consuming published packages.
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-events-backend-module-github': patch
---
Fix the event request validation for incoming requests for GitHub webhook events
by using the raw body when verifying the signature.
+8
View File
@@ -0,0 +1,8 @@
---
'@backstage/plugin-events-node': patch
'@backstage/plugin-events-backend-module-github': patch
'@backstage/plugin-events-backend': patch
---
Add raw body information to `RequestDetails`
and use the raw body when validating incoming event requests.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Fixed an issue with the `repo lint` command where the cache key for the `--successCache` option would not properly ignore files that should be ignored according to `.eslintignore`s.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend': patch
---
Fixed an issue where entities would not be marked for restitching if only the target of a relationship changed.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-events-backend': patch
---
Cleaning up event subscriptions after the max age window
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/repo-tools': minor
---
`backstage-repo-tools package schema openapi generate --server` now generates complete TS interfaces for all request/response objects in your OpenAPI schema. This fixes an edge case around recursive schemas and standardizes both the generated client and server to have similar generated types.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-gitlab': minor
---
Extended the configuration with the `includeArchivedRepos` property, which allows including repositories when the project is archived.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-defaults': patch
---
Use `node-fetch` instead of native fetch, as per https://backstage.io/docs/architecture-decisions/adrs-adr013
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Fix for the `--link` flag for `package start` to deduplicate `react-router` and `react-router-dom`.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-app-visualizer': patch
---
New `devDependency` for local development setup.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Modified `createDryRunner` and corresponding route to include `templateMetaData` inside the `templateInfo`. This allows custom action writers to access things like `templateInfo.entity.metadata.name` via the action context while executing templates using the dry run framework.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/repo-tools': patch
---
The `generate-patch` command will now fall back to always adding a `resolutions` entry, even if no matching descriptors are found.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/create-app': patch
---
Use the main entrypoint for `create-app` installs
+6
View File
@@ -0,0 +1,6 @@
---
'@backstage/plugin-scaffolder-react': minor
'@backstage/plugin-scaffolder': minor
---
Fix `contextMenu` not being disabled bug in new scaffolder pages
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/backend-openapi-utils': minor
---
Adds a new `createValidatedOpenApiRouterFromGeneratedEndpointMap` function that uses the new static server generation in `backstage-cli package schema openapi generate --server` to create a typed express router.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend': minor
---
Added `entity_ref` column to `final_entities` in order to move `refresh_state` away from the read path
+34
View File
@@ -0,0 +1,34 @@
---
'@backstage/plugin-auth-backend-module-cloudflare-access-provider': patch
'@backstage/plugin-catalog-backend-module-incremental-ingestion': patch
'@backstage/plugin-catalog-backend-module-backstage-openapi': patch
'@backstage/plugin-catalog-backend-module-bitbucket-server': patch
'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch
'@backstage/plugin-search-backend-module-elasticsearch': patch
'@backstage/plugin-catalog-backend-module-puppetdb': patch
'@backstage/plugin-catalog-backend-module-msgraph': patch
'@backstage/plugin-catalog-backend-module-gerrit': patch
'@backstage/plugin-catalog-backend-module-github': patch
'@backstage/plugin-catalog-backend-module-gitlab': patch
'@backstage/plugin-catalog-backend-module-azure': patch
'@backstage/plugin-catalog-backend-module-ldap': patch
'@backstage/plugin-catalog-backend-module-aws': patch
'@backstage/plugin-search-backend-module-pg': patch
'@backstage/plugin-notifications-backend': patch
'@backstage/backend-test-utils': patch
'@backstage/plugin-search-backend-node': patch
'@backstage/plugin-notifications-node': patch
'@backstage/plugin-scaffolder-backend': patch
'@backstage/backend-defaults': patch
'@backstage/plugin-permission-common': patch
'@backstage/backend-app-api': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-signals-backend': patch
'@backstage/plugin-proxy-backend': patch
'@backstage/plugin-auth-backend': patch
'@backstage/plugin-signals-node': patch
'@backstage/plugin-auth-node': patch
'@backstage/plugin-signals': patch
---
Upgrade to uuid v11 internally
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Fixed an issue where `.css` style injection would fail for published packages.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/repo-tools': patch
---
Added a new `generate-patch` command that can be used to generate patches for current changes in a source workspace to be installed it a target workspace.
+13
View File
@@ -0,0 +1,13 @@
---
'@backstage/plugin-scaffolder-backend-module-bitbucket-server': patch
'@backstage/plugin-scaffolder-backend-module-bitbucket-cloud': patch
---
Fix double branch creation in `public:bitbucket{Cloud,Server}:pull-request`
This resulted in the following error when using the actions:
```
AlreadyExistsError: Failed to create branch at create-test because it already exists.
```
The issue was original introduced in d103a48fa306d745599dc0c793668c9e6a479d32
+14
View File
@@ -0,0 +1,14 @@
---
'@backstage/plugin-catalog-backend': minor
---
Drop redundant indices from the database.
The following redundant indices are removed in this version:
- `final_entities_entity_id_idx` - overlaps with `final_entities_pkey`
- `refresh_state_entity_id_idx` - overlaps with `refresh_state_pkey`
- `refresh_state_entity_ref_idx` - overlaps with `refresh_state_entity_ref_uniq`
- `search_key_idx` and `search_value_idx` - these were replaced by the composite index `search_key_value_idx` in #22594
No negative end user impact is expected, but rather that performance should increase due to less index churn.
+16
View File
@@ -0,0 +1,16 @@
---
'@backstage/plugin-search-backend-module-stack-overflow-collator': patch
'@backstage/plugin-scaffolder-backend-module-notifications': patch
'@backstage/plugin-auth-backend-module-aws-alb-provider': patch
'@backstage/plugin-auth-backend-module-guest-provider': patch
'@backstage/plugin-notifications-backend-module-email': patch
'@backstage/plugin-auth-backend-module-oidc-provider': patch
'@backstage/plugin-scaffolder-backend-module-yeoman': patch
'@backstage/plugin-notifications-node': patch
'@backstage/backend-app-api': patch
'@backstage/plugin-signals-node': patch
'@backstage/plugin-events-node': patch
'@backstage/cli': patch
---
Remove unused backend-common dependency
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Add new `fs:readdir` action to list current content of the workspace
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend': patch
---
Internal refactor to slightly speed up the processing loop
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/cli': patch
---
Added support for `.webp` files in the frontend tooling.
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-bitbucket-cloud': patch
---
Implemented discovery on project-level to shift Bitbucket Cloud API limits
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-events-node': patch
---
Fixed an issue where the event bus polling would duplicate and increase exponentially over time.
+3 -37
View File
@@ -9,7 +9,7 @@ yarn.lock @backstage/maintainers @backst
*/yarn.lock @backstage/maintainers @backstage-service
/.changeset/*.md
/beps/0001-notifications-system @backstage/maintainers @backstage/notifications-maintainers
/docs/*.md @backstage/documentation-maintainers
/docs @backstage/maintainers @backstage/documentation-maintainers
/docs/assets/search @backstage/search-maintainers
/docs/features/search @backstage/search-maintainers
/docs/features/techdocs @backstage/techdocs-maintainers
@@ -18,15 +18,8 @@ yarn.lock @backstage/maintainers @backst
/packages/backend-openapi-utils @backstage/maintainers @backstage/reviewers @backstage/openapi-tooling-maintainers
/packages/techdocs-cli @backstage/techdocs-maintainers
/packages/techdocs-cli-embedded-app @backstage/techdocs-maintainers
/plugins/adr @backstage/maintainers @backstage/reviewers @kuangp
/plugins/adr-* @backstage/maintainers @backstage/reviewers @kuangp
/plugins/api-docs @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/azure-devops @backstage/maintainers @backstage/reviewers @awanlin
/plugins/azure-devops-backend @backstage/maintainers @backstage/reviewers @awanlin
/plugins/azure-devops-common @backstage/maintainers @backstage/reviewers @awanlin
/plugins/analytics-module-newrelic-browser @backstage/maintainers @backstage/reviewers @jmezach
/plugins/bitbucket-cloud-common @backstage/maintainers @backstage/reviewers @pjungermann
/plugins/bitrise @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/catalog @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers
/plugins/catalog-* @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers
/plugins/catalog-backend-module-aws @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers @pjungermann
@@ -35,53 +28,26 @@ yarn.lock @backstage/maintainers @backst
/plugins/catalog-backend-module-msgraph @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers @pjungermann
/plugins/catalog-backend-module-puppetdb @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers
/plugins/catalog-graph @backstage/maintainers @backstage/reviewers @backstage/catalog-maintainers @backstage/sda-se-reviewers
/plugins/cicd-statistics @backstage/sharks
/plugins/circleci @backstage/maintainers @backstage/reviewers @adamdmharvey
/plugins/code-coverage @backstage/maintainers @backstage/reviewers @alde
/plugins/code-coverage-backend @backstage/maintainers @backstage/reviewers @alde
/plugins/cost-insights @backstage/maintainers @backstage/reviewers @backstage/silver-lining
/plugins/cost-insights-* @backstage/maintainers @backstage/reviewers @backstage/silver-lining
/plugins/devtools @backstage/maintainers @backstage/reviewers @awanlin
/plugins/devtools-backend @backstage/maintainers @backstage/reviewers @awanlin
/plugins/devtools-common @backstage/maintainers @backstage/reviewers @awanlin
/plugins/entity-feedback @backstage/maintainers @backstage/reviewers @kuangp
/plugins/entity-feedback-* @backstage/maintainers @backstage/reviewers @kuangp
/plugins/events-* @backstage/maintainers @backstage/reviewers @backstage/events-maintainers
/plugins/explore @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/explore-react @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/fossa @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/git-release-manager @backstage/maintainers @backstage/reviewers @erikengervall
/plugins/home @backstage/home-maintainers
/plugins/home-* @backstage/home-maintainers
/plugins/kafka @backstage/maintainers @backstage/reviewers @andrewthauer
/plugins/kafka-backend @backstage/maintainers @backstage/reviewers @andrewthauer
/plugins/kubernetes @backstage/kubernetes-maintainers
/plugins/kubernetes-* @backstage/kubernetes-maintainers
/plugins/linguist @backstage/maintainers @backstage/reviewers @awanlin
/plugins/linguist-backend @backstage/maintainers @backstage/reviewers @awanlin
/plugins/linguist-common @backstage/maintainers @backstage/reviewers @awanlin
/plugins/notifications @backstage/maintainers @backstage/notifications-maintainers
/plugins/notifications-* @backstage/maintainers @backstage/notifications-maintainers
/plugins/scaffolder-backend-module-notifications @backstage/maintainers @backstage/notifications-maintainers
/plugins/octopus-deploy @backstage/maintainers @backstage/reviewers @jmezach
/plugins/permission-* @backstage/permission-maintainers
/plugins/playlist @backstage/maintainers @backstage/reviewers @kuangp
/plugins/playlist-* @backstage/maintainers @backstage/reviewers @kuangp
/plugins/rollbar @backstage/maintainers @backstage/reviewers @andrewthauer
/plugins/rollbar-backend @backstage/maintainers @backstage/reviewers @andrewthauer
/plugins/scaffolder @backstage/maintainers @backstage/reviewers @backstage/scaffolder-maintainers
/plugins/scaffolder-* @backstage/maintainers @backstage/reviewers @backstage/scaffolder-maintainers
/plugins/search @backstage/search-maintainers
/plugins/search-* @backstage/search-maintainers
/plugins/signals @backstage/maintainers @backstage/notifications-maintainers
/plugins/signals-* @backstage/maintainers @backstage/notifications-maintainers
/plugins/sonarqube @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/techdocs @backstage/techdocs-maintainers
/plugins/techdocs-* @backstage/techdocs-maintainers
/plugins/user-settings @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/user-settings-backend @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
/plugins/tech-insights-backend @backstage/maintainers @backstage/reviewers @xantier
/plugins/tech-insights-backend-module-jsonfc @backstage/maintainers @backstage/reviewers @xantier
/plugins/tech-insights-tech-insights-common @backstage/maintainers @backstage/reviewers @xantier
/plugins/tech-insights-tech-insights-node @backstage/maintainers @backstage/reviewers @xantier
knip-report.md
/plugins/user-settings-common @backstage/maintainers @backstage/reviewers @backstage/sda-se-reviewers
@@ -74,6 +74,7 @@ configmaps
configs
const
cookiecutter
corepack
Corti
cron
cronjobs
@@ -176,6 +177,7 @@ idempotency
Iglesias
iLert
img
impactful
incentivised
Indal
indexable
@@ -368,6 +370,8 @@ scaffolded
scaffolder
Scaffolder
scrollbar
SCM
SCMs
sdks
seb
semlas
@@ -90,7 +90,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@eef61447b9ff4aafe5dcd4e0bbf5d482be7e7871 # v4
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
# Identify comment to be updated
- name: Find comment for API Changes
+1 -1
View File
@@ -27,7 +27,7 @@ jobs:
run: git fetch --depth 1 origin ${{ github.base_ref }}
- name: setup-node
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
registry-url: https://registry.npmjs.org/
+5 -5
View File
@@ -35,7 +35,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -71,7 +71,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -219,7 +219,7 @@ jobs:
run: git fetch origin ${{ github.event.pull_request.base.ref }}
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -235,7 +235,7 @@ jobs:
# Use the lower-level cache actions for the success cache, so that we can store the cache even on failed builds
- name: restore backstage-cli cache
uses: actions/cache/restore@3624ceb22c1c5a301c8db4169662070a689d9ea8 # v4
uses: actions/cache/restore@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4
with:
path: .cache/backstage-cli
key: ${{ runner.os }}-v${{ matrix.node-version }}-backstage-cli-${{ github.run_id }}
@@ -256,7 +256,7 @@ jobs:
# Always save success cache even if there were failures, that way it can be used in re-triggered builds
- name: save backstage-cli cache
uses: actions/cache/save@3624ceb22c1c5a301c8db4169662070a689d9ea8 # v4
uses: actions/cache/save@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4
if: always()
with:
path: .cache/backstage-cli
+1 -1
View File
@@ -31,7 +31,7 @@ jobs:
ref: ${{ github.event.client_payload.version && env.RELEASE_VERSION || github.ref }}
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
+4 -4
View File
@@ -59,7 +59,7 @@ jobs:
ref: refs/tags/${{ steps.find-release.outputs.result }}
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -99,7 +99,7 @@ jobs:
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -163,7 +163,7 @@ jobs:
egress-policy: audit
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -225,7 +225,7 @@ jobs:
run: ls microsite/build && ls microsite/build/storybook
- name: Deploy both microsite and storybook to gh-pages
uses: JamesIves/github-pages-deploy-action@881db5376404c5c8d621010bcbec0310b58d5e29 # v4.6.8
uses: JamesIves/github-pages-deploy-action@62fec3add6773ec5dbbf18d2ee4260911aa35cf4 # v4.6.9
with:
branch: gh-pages
folder: microsite/build
+2 -2
View File
@@ -71,7 +71,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -94,7 +94,7 @@ jobs:
run: yarn backstage-cli config:check --lax
- name: backstage-cli cache
uses: actions/cache@3624ceb22c1c5a301c8db4169662070a689d9ea8 # v4
uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4
with:
path: .cache/backstage-cli
key: ${{ runner.os }}-v${{ matrix.node-version }}-backstage-cli-${{ github.run_id }}
+1 -1
View File
@@ -20,7 +20,7 @@ jobs:
fetch-depth: 0
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
+1 -1
View File
@@ -19,7 +19,7 @@ jobs:
ref: v${{ github.event.client_payload.version }}
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -19,7 +19,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
registry-url: https://registry.npmjs.org/ # Needed for auth
+1 -1
View File
@@ -26,7 +26,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
- name: yarn install
+1 -1
View File
@@ -53,7 +53,7 @@ jobs:
git config --global user.name 'GitHub e2e user'
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
+1 -1
View File
@@ -35,7 +35,7 @@ jobs:
egress-policy: audit
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: '3.9'
+2 -2
View File
@@ -50,13 +50,13 @@ jobs:
git config --global user.name 'GitHub e2e user'
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
- name: setup python
uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5.2.0
uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5.3.0
with:
python-version: '3.10'
+2 -2
View File
@@ -31,10 +31,10 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
- uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5
- uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5
with:
python-version: '3.9'
@@ -22,7 +22,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: Use Node.js 20.x
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: 20.x
+2 -2
View File
@@ -37,7 +37,7 @@ jobs:
fetch-depth: 0 # Required to retrieve git history
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
@@ -51,7 +51,7 @@ jobs:
- run: yarn build-storybook
- uses: chromaui/action@25f8ff36486472c2d6b5b02dc2d277f051a3ecdb # v11
- uses: chromaui/action@0efa3230f403b7848d5d65c6ce140b617fb68380 # v11
with:
token: ${{ secrets.GITHUB_TOKEN }}
# projectToken intentionally shared to allow collaborators to run Chromatic on forks
+1 -1
View File
@@ -36,7 +36,7 @@ jobs:
- uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
- name: use node.js ${{ matrix.node-version }}
uses: actions/setup-node@0a44ba7841725637a19e28fa30b79a866c81b0a6 # v4.0.4
uses: actions/setup-node@39370e3970a6d050c480ffad4ff0ed4d3fdee5af # v4.1.0
with:
node-version: ${{ matrix.node-version }}
registry-url: https://registry.npmjs.org/ # Needed for auth
+1 -1
View File
@@ -276,4 +276,4 @@ _You can do this by using the [Adopter form](https://info.backstage.spotify.com/
| [Cigna](https://www.cigna.com/) / [Evernorth](https://www.evernorth.com/) | [@raphtalia](https://github.com/raphtalia), [Devon Paluso](mailto:Devon.Paluso@evernorth.com), [Bryan Rego](mailto:Bryan.Rego@evernorth.com), [Ian Skillings](mailto:Ian.Skillings@evernorth.com) | Internal developer portal providing TechDocs, software templates, centralized secret management, with information consolidation from ServiceNow, Okta, GitHub, GitLab, and WebEx. |
| [Infobip](https://www.infobip.com/) | [Antonio Ereiz](https://github.com/SonilPro) | Visual representation of all our entities registered within an existing internal catalog, along with a UI for editing their manifests. It serves as the go-to place for new internal tools that require a user interface and provides standardization of new components using Software Templates.
| [CloudScript](https://www.cloudscript.com.br/) | [Helias Rodrigues](https://github.com/xcloudscript) | We use it to centralize and organize the components of our internal development platform. In addition, it provides an integrated experience for developers by using all the core modules and some plugins.
| [Alauda](https://www.alauda.io/) | [Mario](https://github.com/mario-mui) | We use it to centralize and organize the components of our internal development platform. In addition, it provides environment templates for developers to create development testing or others environments
+1
View File
@@ -204,6 +204,7 @@ Scope: The Backstage Documentation
| Irma Solakovic | Roadie.io | [Irma12](https://github.com/Irma12) | `Irma#7629` |
| Jorge Lainfiesta | Roadie.io | [jorgelainfiesta](https://github.com/jorgelainfiesta) | `jorgel#8733` |
| Jussi Hallila | Roadie.io | [Xantier](https://github.com/Xantier) | `Xantier#0086` |
| Kashish Mittal | Red Hat | [04kash](https://github.com/04kash) | `kashh._.` |
| Mark Avery | Cvent | [webark](https://github.com/webark) | `webark#8471` |
| Miklós Kiss | Roadie.io | [kissmikijr](https://github.com/kissmikijr) | `Miklos#7416` |
| Patrick Jungermann | Bonial International GmbH | [pjungermann](https://github.com/pjungermann) | `pjungermann#6933` |
-3
View File
@@ -1,6 +1,3 @@
> [!NOTE]
> 🏖 From Monday October 28th through November 4th, maintainers and Spotify employees will be on vacation due to Wellness Week. Expect the project to move a little slower than normal, and support to be limited. Normal service will resume after that! 🏝
[![headline](docs/assets/headline.png)](https://backstage.io/)
# [Backstage](https://backstage.io)
+1 -1
View File
@@ -20,4 +20,4 @@ metadata:
spec:
type: library
owner: CNCF
lifecycle: experimental
lifecycle: production
@@ -7,14 +7,14 @@ description: Architecture Decision Record (ADR) logs as a reference point for th
## Decision
A decision was made to store ADRs in a log in the project repository
A decision was made to store ADRs in a log in the project repository.
## Discussion
There is a need to store big decisions made in a log as a reference point for
the team, help with onboarding new members and give context to others interested
the team, help with onboarding new members, and give context to others interested
in the project.
## Risks
People stop adding ADRs to the log and context gets lost
People stop adding ADRs to the log and context gets lost.
@@ -7,9 +7,9 @@ description: Architecture Decision Record (ADR) log on Default Software Catalog
## Background
Backstage comes with a software catalog functionality, that you can use to track
Backstage comes with software catalog functionality that you can use to track
all your software components and more. It can be powered by data from various
sources, and one of them that is included with the package, is a custom database
sources, and one of them that is included with the package is a custom database
backed catalog. It has the ability to keep itself updated automatically based on
the contents of little descriptor files in your version control system of
choice. Developers create these files and maintain them side by side with their
@@ -21,15 +21,15 @@ This ADR describes the default format of these descriptor files.
Internally at Spotify, a homegrown software catalog system is used heavily and
forms a core part of Backstage and other important pieces of the infrastructure.
The user experience, learnings and certain pieces of metadata from that catalog
The user experience, learnings, and certain pieces of metadata from that catalog
are being carried over to the open source effort.
The file format described herein, also draws heavy inspiration from the
The file format described herein also draws heavy inspiration from the
[kubernetes object format](https://kubernetes.io/docs/concepts/overview/working-with-objects/kubernetes-objects/).
### Core Concepts
There are a number of descriptor files, all of whose locations (e.g. within a
There are a number of descriptor files, all of whose locations (e.g., within a
version control system) are registered with the software catalog. The method of
registration is not covered in this document; it could happen either manually
inside Backstage, or by push events from a CI/CD pipelines, or by webhook
@@ -45,7 +45,7 @@ Entities have distinct names, and they may reference each other by those names.
## Format
Descriptor files use the [YAML](https://yaml.org/spec/1.2/spec.html) format.
They may be written by hand, or created using automated tools. Each file may
They may be written by hand or created using automated tools. Each file may
consist of several YAML documents (separated by `---`), where each document
describes a single entity.
@@ -71,7 +71,7 @@ spec:
```
The root fields `apiVersion`, `kind`, `metadata`, and `spec` are part of the
_envelope_, defining the overall structure of all kinds of entity. Likewise, the
_envelope_, defining the overall structure of all kinds of entities. Likewise, the
`name`, `namespace`, `labels`, and `annotations` metadata fields are of special
significance and have reserved purposes and distinct shapes.
@@ -87,23 +87,23 @@ The `kind` is the high level entity type being described, typically from the
[Backstage system model](https://github.com/backstage/backstage/issues/390). The
first versions of the catalog will focus on the `Component` kind.
The `apiVersion`is the version of specification format for that particular
The `apiVersion` is the version of the specification format for that particular
entity that this file is written against. The version is used for being able to
evolve the format, and the tuple of `apiVersion` and `kind` should be enough for
a parser to know how to interpret the contents of the rest of the document.
Backstage specific entities have an `apiVersion` that is prefixed with
`backstage.io/`, to distinguish them from other types of object that share the
`backstage.io/`, to distinguish them from other types of objects that share the
same type of structure. This may be relevant when co-hosting these
specifications with e.g. kubernetes object manifests.
specifications with, e.g., Kubernetes object manifests.
Early versions of the catalog will be using alpha/beta versions, e.g.
`backstage.io/v1alpha1`, to signal that the format may still change. After that,
Early versions of the catalog will be using alpha/beta versions, e.g.,
`backstage.io/v1alpha1` to signal that the format may still change. After that,
we will be using `backstage.io/v1` and up.
### `metadata`
A structure that contains metadata about the entity, i.e. things that aren't
A structure that contains metadata about the entity, i.e., things that aren't
directly part of the entity specification itself. See below for more details
about this structure.
@@ -142,40 +142,40 @@ Example: `visits-tracking-service`, `CircleciBuildsDs_avro_gcs`
### `namespace`
The `name` of a namespace that the entity belongs to. This field is optional,
The `name` of a namespace that the entity belongs to. This field is optional
and currently has no special semantics apart from bounding the name uniqueness
constraint if specified. It is reserved for future use and may get broader
semantic implication.
Namespaces may also be part of the catalog, and are `v1` / `Namespace` entities,
i.e. not Backstage specific but the same as in Kubernetes.
Namespaces may also be part of the catalog and are `v1` / `Namespace` entities,
i.e., not Backstage specific but the same as in Kubernetes.
### `description`
A human readable description of the entity, to be shown in Backstage. Should be
A human readable description of the entity to be shown in Backstage. Should be
kept short and informative, suitable to give an overview of the entity's purpose
at a glance. More detailed explanations and documentation should be placed
elsewhere.
### `labels`
Labels are optional key/value pairs of that are attached to the entity, and
Labels are optional key/value pairs that are attached to the entity, and
their use is identical to
[kubernetes object labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/).
Their main purpose is for references to other entities, and for information that
Their main purpose is for references to other entities and for information that
is in one way or another classifying for the current entity. They are often used
as values in queries or filters.
Both the key and the value are strings, subject to the following restrictions.
Keys have an optional prefix followed by a slash, and then the name part which
Keys have an optional prefix followed by a slash, and then the name part, which
is required. The prefix must be a valid lowercase domain name, at most 253
characters in total. The name part must be sequences of `[a-zA-Z0-9]` separated
by any of `[-_.]`, at most 63 characters in total.
The `backstage.io/` prefix is reserved for use by Backstage core components.
Some keys such as `system` also have predefined semantics.
Some keys, such as `system` also have predefined semantics.
Values are strings that follow the same restrictions as `name` above.
@@ -186,19 +186,19 @@ identical in use to
[kubernetes object annotations](https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/).
Their purpose is mainly, but not limited, to reference into external systems.
This could for example be a reference to the git ref the entity was ingested
This could, for example, be a reference to the git ref the entity was ingested
from, to monitoring and logging systems, to pagerduty schedules, etc.
Both the key and the value are strings, subject to the following restrictions.
Keys have an optional prefix followed by a slash, and then the name part which
Keys have an optional prefix followed by a slash, and then the name part, which
is required. The prefix must be a valid lowercase domain name, at most 253
characters in total. The name part must be sequences of `[a-zA-Z0-9]` separated
by any of `[-_.]`, at most 63 characters in total.
The `backstage.io/` prefix is reserved for use by Backstage core components.
Values can be of any length, but are limited to being strings.
Values can be of any length but are limited to being strings.
## Component

Some files were not shown because too many files have changed in this diff Show More