paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 48 Packages Projects Releases Wiki Activity

Merge branch 'master' of github.com:Niksko/backstage into docs-build-strategy

Browse Source
This commit is contained in:
Nikolas Skoufis
2022-02-27 18:26:57 +11:00
parent 2a865343c2 022891fe78
commit 54027cb0f6
1081 changed files with 21003 additions and 9522 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/angry-bottles-mix.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/cli': patch
---
Added a new experimental and hidden `backstage-cli repo lint` command that can be used to lint all packages in the project, similar to `lerna run lint`.
.changeset/beige-feet-tap.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-techdocs-backend': patch
---
Do not use cross-fetch in the backend
.changeset/blue-jobs-know.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/cli': patch
---
The `versions:bump --release next` command is updated to compare the `main` and `next` release manifests and prefer the latest.
.changeset/brave-singers-burn.md
-13
View File
@@ -1,13 +0,0 @@
---
'@backstage/plugin-catalog-backend': patch
---
The following processors now properly accept an `ScmIntegrationRegistry` (an
interface) instead of an `ScmIntegrations` (which is a concrete class).
- `AzureDevOpsDiscoveryProcessor`
- `CodeOwnersProcessor`
- `GitLabDiscoveryProcessor`
- `GithubDiscoveryProcessor`
- `GithubMultiOrgReaderProcessor`
- `GithubOrgReaderProcessor`
.changeset/bright-games-eat.md
-24
View File
@@ -1,24 +0,0 @@
---
'@backstage/create-app': patch
---
Remove SearchContextProvider from `<Root />`
The `SidebarSearchModal` exported from `plugin-search` internally renders `SearchContextProvider`, so it can be removed from `Root.tsx`:
```diff
-import {
- SidebarSearchModal,
- SearchContextProvider,
-} from '@backstage/plugin-search';
+import { SidebarSearchModal } from '@backstage/plugin-search';
... omitted ...
<SidebarGroup label="Search" icon={<SearchIcon />} to="/search">
- <SearchContextProvider>
- <SidebarSearchModal />
- </SearchContextProvider>
+ <SidebarSearchModal />
</SidebarGroup>
```
.changeset/bright-nails-grin.md
-78
View File
@@ -1,78 +0,0 @@
---
'@backstage/backend-common': patch
'@backstage/catalog-client': patch
'@backstage/cli': patch
'@backstage/config-loader': patch
'@backstage/core-app-api': patch
'@backstage/core-components': patch
'@backstage/core-plugin-api': patch
'@backstage/errors': patch
'@backstage/integration': patch
'@backstage/integration-react': patch
'@backstage/release-manifests': patch
'@backstage/test-utils': patch
'@backstage/plugin-airbrake': patch
'@backstage/plugin-allure': patch
'@backstage/plugin-analytics-module-ga': patch
'@backstage/plugin-apache-airflow': patch
'@backstage/plugin-api-docs': patch
'@backstage/plugin-auth-backend': patch
'@backstage/plugin-auth-node': patch
'@backstage/plugin-azure-devops': patch
'@backstage/plugin-badges': patch
'@backstage/plugin-bazaar': patch
'@backstage/plugin-bitrise': patch
'@backstage/plugin-catalog': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-catalog-backend-module-msgraph': patch
'@backstage/plugin-catalog-graphql': patch
'@backstage/plugin-catalog-import': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-circleci': patch
'@backstage/plugin-cloudbuild': patch
'@backstage/plugin-code-coverage': patch
'@backstage/plugin-config-schema': patch
'@backstage/plugin-cost-insights': patch
'@backstage/plugin-explore': patch
'@backstage/plugin-explore-react': patch
'@backstage/plugin-firehydrant': patch
'@backstage/plugin-fossa': patch
'@backstage/plugin-gcp-projects': patch
'@backstage/plugin-git-release-manager': patch
'@backstage/plugin-github-actions': patch
'@backstage/plugin-github-deployments': patch
'@backstage/plugin-gitops-profiles': patch
'@backstage/plugin-gocd': patch
'@backstage/plugin-graphiql': patch
'@backstage/plugin-home': patch
'@backstage/plugin-ilert': patch
'@backstage/plugin-jenkins': patch
'@backstage/plugin-kafka': patch
'@backstage/plugin-kubernetes': patch
'@backstage/plugin-lighthouse': patch
'@backstage/plugin-newrelic': patch
'@backstage/plugin-newrelic-dashboard': patch
'@backstage/plugin-org': patch
'@backstage/plugin-pagerduty': patch
'@backstage/plugin-permission-backend': patch
'@backstage/plugin-permission-common': patch
'@backstage/plugin-permission-react': patch
'@backstage/plugin-rollbar': patch
'@backstage/plugin-rollbar-backend': patch
'@backstage/plugin-scaffolder': patch
'@backstage/plugin-scaffolder-backend': patch
'@backstage/plugin-search': patch
'@backstage/plugin-sentry': patch
'@backstage/plugin-shortcuts': patch
'@backstage/plugin-sonarqube': patch
'@backstage/plugin-splunk-on-call': patch
'@backstage/plugin-tech-insights': patch
'@backstage/plugin-tech-radar': patch
'@backstage/plugin-techdocs': patch
'@backstage/plugin-techdocs-backend': patch
'@backstage/plugin-todo': patch
'@backstage/plugin-user-settings': patch
'@backstage/plugin-xcmetrics': patch
---
Bump `node-fetch` to version 2.6.7 and `cross-fetch` to version 3.1.5
.changeset/brown-impalas-greet.md
-6
View File
@@ -1,6 +0,0 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Fix error handling of the `runCommand` helper to return `Error`
instance.
.changeset/chilly-goats-suffer.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Applied fix from version 0.17.2 of this package, which is part of the v0.69.2 release of Backstage.
.changeset/clever-pears-turn.md
-11
View File
@@ -1,11 +0,0 @@
---
'@backstage/plugin-catalog': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-catalog-graph': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-org': patch
'@backstage/plugin-scaffolder': patch
'@backstage/plugin-tech-insights-backend': patch
---
Use updated type names from `@backstage/catalog-client`
.changeset/curvy-worms-exercise.md
-6
View File
@@ -1,6 +0,0 @@
---
'@backstage/catalog-model': patch
---
Deprecated `parseLocationReference` and `stringifyLocationReference`,
introducing `parseLocationRef` and `stringifyLocationRef` in their place.
.changeset/cyan-oranges-sit.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/catalog-model': patch
---
Deprecates the `Location` type export from this package. Imports of the `Location` type should now be done from the `@backstage/catalog-client` package instead.
.changeset/dependabot-8ed326b.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-search-backend-module-elasticsearch': patch
---
chore(deps-dev): bump `@elastic/elasticsearch-mock` from 0.3.0 to 1.0.0
.changeset/dry-lies-move.md
-6
View File
@@ -1,6 +0,0 @@
---
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-todo-backend': patch
---
Replace usage of `serializeEntityRef` with `stringifyEntityRef`
.changeset/eight-adults-joke.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-analytics-module-ga': patch
---
Added CSP instructions to README
.changeset/fair-bees-join.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/catalog-model': patch
---
Deprecated `ENTITY_DEFAULT_NAMESPACE` constant in favour of `DEFAULT_NAMESPACE`.
.changeset/fair-emus-check.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-catalog': patch
---
Replaced use of deprecated `compareEntityToRef` utility.
.changeset/fair-eyes-collect.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/catalog-model': patch
---
Deprecated `compareEntityToRef` due to low usage and provided value.
.changeset/fast-ducks-sell.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-catalog-backend': patch
---
Support "dependencyOf" relation in Resource entities
.changeset/fast-lizards-fly.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-auth-backend': patch
---
Bump `passport-oauth2` to version 1.6.1
.changeset/fast-mangos-tell.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-scaffolder-backend': minor
---
**BREAKING**: Updated `TemplateAction` and related types to have its type parameter extend `JsonObject` instead of `InputBase`. The `createTemplateAction` has also been updated to pass through the `TInput` type parameter to the return type, meaning the `TemplateAction` retains its type. This can lead to breakages during type checking especially within tests.
.changeset/fast-paws-arrive.md
+31
View File
@@ -0,0 +1,31 @@
---
'@backstage/create-app': patch
---
Update the template to reflect the renaming of `DocsResultListItem` to `TechDocsSearchResultListItem` from `@backstage/plugin-techdocs`.
To apply this change to an existing app, make the following change to `packages/app/src/components/search/SearchPage.tsx`:
```diff
-import { DocsResultListItem } from '@backstage/plugin-techdocs';
+import { TechDocsSearchResultListItem } from '@backstage/plugin-techdocs';
```
```diff
case 'techdocs':
return (
- <DocsResultListItem
+ <TechDocsSearchResultListItem
key={document.location}
result={document}
/>
```
The `TechDocsIndexPage` now uses `DefaultTechDocsHome` as fall back if no children is provided as `LegacyTechDocsHome` is marked as deprecated. If you do not use a custom techdocs homepage, you can therefore update your app to the following:
```diff
- <Route path="/docs" element={<TechDocsIndexPage />}>
- <DefaultTechDocsHome />
- </Route>
+ <Route path="/docs" element={<TechDocsIndexPage />} />
```
.changeset/fast-stingrays-hope.md
-8
View File
@@ -1,8 +0,0 @@
---
'@backstage/plugin-catalog': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-catalog-backend-module-ldap': patch
---
Import `Location` from the `@backstage/catalog-client` package.
.changeset/flat-crabs-smash.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/cli': patch
---
The `versions:bump` command now filters out `npm_` environment configuration when running `yarn install`. This has the effect of allowing it to consider local configuration files within the repository, which is the behavior that one would expect.
.changeset/funny-crabs-drop.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-catalog': minor
---
Removed `CatalogClientWrapper` as usage have been replaced by the `fetchApiRef`.
.changeset/green-bobcats-burn.md
-22
View File
@@ -1,22 +0,0 @@
---
'@backstage/plugin-permission-backend': minor
---
Add a warning if the permission backend is used without setting `permission.enabled=true`.
**BREAKING** Permission backend's `createRouter` now requires a `config` option.
```diff
// packages/backend/src/plugins/permission.ts
...
export default async function createPlugin({
...
+ config,
}: PluginEnvironment) {
return createRouter({
...
+ config,
});
}
```
.changeset/happy-lemons-drop.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-permission-common': minor
---
**BREAKING** `PermissionCriteria` now requires at least one condition in `anyOf` and `allOf` arrays. This addresses some ambiguous behavior outlined in #9280.
.changeset/hip-carrots-suffer.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-techdocs-backend': patch
---
Fix bug where tech docs collator stores search indices with wrong entity ref casing. Make the collator to conform legacyPathCasing configuration option.
.changeset/honest-shrimps-clap.md
-9
View File
@@ -1,9 +0,0 @@
---
'@backstage/catalog-client': minor
---
**BREAKING**: Removed the explicit `DiscoveryApi` and `FetchApi` export symbols,
which were unnecessary duplicates from the well known core ones.
The `CATALOG_FILTER_EXISTS` symbol's value has changed. However, this should not
affect any code in practice.
.changeset/hungry-apples-sparkle.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/catalog-model': patch
---
Deprecated the `EntityRefContext` type which had limited use.
.changeset/khaki-socks-wash.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Set timeout for scaffolder octokit client
.changeset/lazy-jeans-obey.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-catalog-backend': patch
---
Update internal `Location` validation.
.changeset/little-carpets-itch.md
+14
View File
@@ -0,0 +1,14 @@
---
'@backstage/plugin-scaffolder': patch
---
Added some deprecations as follows:
- **DEPRECATED**: `TemplateCardComponent` and `TaskPageComponent` props have been deprecated, and moved to a `components` prop instead. You can pass them in through there instead.
- **DEPRECATED**: `TemplateList` and `TemplateListProps` has been deprecated. Please use the `TemplateCard` to create your own list component instead.
- **DEPRECATED**: `setSecret` has been deprecated in favour of `setSecrets` when calling `useTemplateSecrets`
Other notable changes:
- `scaffolderApi.scaffold()` `values` type has been narrowed from `Record<string, any>` to `Record<string, JsonValue>` instead.
- Moved all navigation internally over to using `routeRefs` and `subRouteRefs`
.changeset/little-ravens-kick.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/cli': patch
---
The `versions:bump` command now also considers the root `package.json` when searching for updates. It has also received updates to its output, including a link the [Backstage upgrade helper](https://backstage.github.io/upgrade-helper) and silenced `yarn install` output.
.changeset/lovely-goats-press.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs': patch
---
Collapse techdocs sidebar on small devices
.changeset/mighty-beds-fix.md
-11
View File
@@ -1,11 +0,0 @@
---
'@backstage/catalog-client': patch
'@backstage/techdocs-common': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-github-deployments': patch
'@backstage/plugin-scaffolder-backend': patch
'@backstage/plugin-todo-backend': patch
---
Updated to use new names for `parseLocationRef` and `stringifyLocationRef`
.changeset/moody-knives-jump.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-cicd-statistics': patch
---
Updated `@backstage/core-plugin-api` dependency.
.changeset/olive-flies-reflect.md
-6
View File
@@ -1,6 +0,0 @@
---
'@backstage/catalog-model': minor
---
**BREAKING**: Remove deprecated validation methods `analyzeLocationSchema`, `locationSchema` and `locationSpecSchema`.
This functionality was primarily used internally by the `catalog-backend`.
.changeset/patched.json
+3 -1
View File
@@ -1,3 +1,5 @@
{
"currentReleaseVersion": {}
"currentReleaseVersion": {
"@backstage/plugin-scaffolder-backend": "0.17.2"
}
}
.changeset/perfect-papayas-crash.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-permission-node': minor
---
**BREAKING** `PermissionCriteria` now requires at least one condition in `anyOf` and `allOf` arrays. This addresses some ambiguous behavior outlined in #9280.
.changeset/pink-onions-ring.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-catalog': minor
---
**BREAKING** Completely removed the `EntitySystemDiagramCard` component which was deprecated in a previous release. Any remaining references to this component are now broken and should be replaced with `EntityCatalogGraphCard`, which can be imported from package `@backstage/plugin-catalog-graph`.
.changeset/plenty-boxes-wink.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/catalog-model': minor
---
**BREAKING**: Remove deprecated `serializeEntityRef` which is replaced by `stringifyEntityRef`.
.changeset/polite-dots-train.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-scaffolder-backend-module-yeoman': patch
---
Bump `yeoman-environment` dependency from `^3.6.0` to `^3.9.1`.
.changeset/proud-fishes-carry.md
-6
View File
@@ -1,6 +0,0 @@
---
'@backstage/plugin-catalog': minor
---
Removed deprecated `Router` and `EntityPageLayout` exports.
`Router` is replaced by plugin extensions and `EntityPageLayout` is replaced by `CatalogEntityPage`.
.changeset/purple-files-hang.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/catalog-client': patch
---
Export the `Location` type that was previously exported by the `@backstage/catalog-model` package.
.changeset/seven-rocks-share.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/integration-react': patch
---
Updated the `ScmAuth` error message for missing provider configurations to link to `ScmAuthApi` setup documentation.
.changeset/shaggy-readers-explain.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Cleanup API report
.changeset/shy-peaches-begin.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-catalog-react': patch
---
Fix CatalogPage showing all components when owned filter was pre-selected
.changeset/silly-ghosts-dance.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-techdocs': patch
---
Improve overall appearance of highlighted code in docs.
.changeset/smart-items-fry.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Applied fix from `v0.17.1` of this package which is part of the `v0.69.1` release of Backstage.
.changeset/sour-hats-love.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/backend-common': patch
---
Updated `isDatabaseConflictError` to handle modern sqlite conflict errors
.changeset/spicy-items-itch.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-jenkins-backend': patch
---
The `DefaultJenkinsInfoProvider.fromConfig` now requires an implementation of the `CatalogApi` rather than a `CatalogClient` instance.
.changeset/spicy-lies-grin.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend-module-ldap': patch
---
Fixed bug in Catalog LDAP module to acknowledge page events to continue receiving entries if pagePause=true
.changeset/stupid-cows-design.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/catalog-model': patch
---
Deprecates the following exports which all have very limited and internal use. `ENTITY_META_GENERATED_FIELDS`, `entityHasChanges`, `generateEntityEtag`, `generateEntityUid`, `generateUpdatedEntity`, `ENTITY_META_GENERATED_FIELDS`.
.changeset/sweet-keys-dress.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/cli': patch
---
Updated the default [sucrase](https://github.com/alangpierce/sucrase)-based Jest transform to include source maps if the environment variable `ENABLE_SOURCE_MAPS` is non-empty. This can be used to better support editor test debugging integrations.
.changeset/swift-rules-hunt.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/techdocs-common': patch
---
adds passing projectID to the Storage client
.changeset/tasty-eagles-retire.md
-11
View File
@@ -1,11 +0,0 @@
---
'@backstage/catalog-client': patch
---
Deprecated the following types used by the catalog client, and created new
corresponding types to make them more consistent:
- `CatalogEntitiesRequest` -> `GetEntitiesRequest`
- `CatalogListResponse` was removed and generally replaced with `GetEntitiesResponse` (which does not use a type parameter argument)
- `CatalogEntityAncestorsRequest`-> `GetEntityAncestorsRequest`
- `CatalogEntityAncestorsResponse` -> `GetEntityAncestorsResponse`
.changeset/tasty-taxis-dance.md
-14
View File
@@ -1,14 +0,0 @@
---
'@backstage/catalog-client': patch
'@backstage/plugin-catalog': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-catalog-backend-module-ldap': patch
'@backstage/plugin-catalog-backend-module-msgraph': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-github-deployments': patch
'@backstage/plugin-scaffolder-backend': patch
'@backstage/plugin-todo': patch
'@backstage/plugin-todo-backend': patch
---
Replaces use of deprecated catalog-model constants.
.changeset/techdocs-cats-whisper.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs': patch
---
Remove copyright from old footer in documentation generated with previous version of `mkdocs-techdocs-plugin` (`v0.2.2`).
.changeset/techdocs-toes-lie.md
+5
View File
@@ -0,0 +1,5 @@
---
'@techdocs/cli': patch
---
Bump `@backstage/techdocs-common` to `0.11.10` to use `spotify/techdocs:v0.3.7` which upgrades `mkdocs-theme` as a dependency of `mkdocs-techdocs-core`.
.changeset/techdocs-war-on-war.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs': patch
---
Fixed a bug that could cause searches in the in-context TechDocs search bar to show results from a different TechDocs site.
.changeset/three-roses-swim.md
-18
View File
@@ -1,18 +0,0 @@
---
'@backstage/techdocs-common': patch
'@backstage/plugin-auth-backend': patch
'@backstage/plugin-badges': patch
'@backstage/plugin-badges-backend': patch
'@backstage/plugin-catalog': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-catalog-graph': patch
'@backstage/plugin-catalog-react': patch
'@backstage/plugin-cost-insights': patch
'@backstage/plugin-ilert': patch
'@backstage/plugin-org': patch
'@backstage/plugin-pagerduty': patch
'@backstage/plugin-search': patch
'@backstage/plugin-techdocs-backend': patch
---
Replace use of deprecated `ENTITY_DEFAULT_NAMESPACE` constant with `DEFAULT_NAMESPACE`.
.changeset/tidy-boxes-sell.md
-18
View File
@@ -1,18 +0,0 @@
---
'@backstage/plugin-search': minor
---
**BREAKING**: `useSearch` doesn't return anymore `open` and `toggleModal`.
The two properties have been moved to the `useSearchModal` hook.
```
import { SearchModal, useSearchModal } from '@backstage/plugin-search';
const Foo = () => {
const { state, setOpen, toggleModal } = useSearchModal();
return (
<SearchModal {...state} toggleModal={toggleModal} />
);
};
```
.changeset/tiny-lobsters-exercise.md
+29
View File
@@ -0,0 +1,29 @@
---
'@backstage/plugin-techdocs': minor
---
**BREAKING:**
Table column utilities `createNameColumn`, `createOwnerColumn`, `createTypeColumn` as well as actions utilities `createCopyDocsUrlAction` and `createStarEntityAction` are no longer directly exported. Instead accessible through DocsTable and EntityListDocsTable.
Use as following:
```tsx
DocsTable.columns.createNameColumn();
DocsTable.columns.createOwnerColumn();
DocsTable.columns.createTypeColumn();
DocsTable.actions.createCopyDocsUrlAction();
DocsTable.actions.createStarEntityAction();
```
- Renamed `DocsResultListItem` to `TechDocsSearchResultListItem`, leaving the old name in place as a deprecations.
- Renamed `TechDocsPage` to `TechDocsReaderPage`, leaving the old name in place as a deprecations.
- Renamed `TechDocsPageRenderFunction` to `TechDocsPageRenderFunction`, leaving the old name in place as a deprecations.
- Renamed `TechDocsPageHeader` to `TechDocsReaderPageHeader`, leaving the old name in place as a deprecations.
- `LegacyTechDocsHome` marked as deprecated and will be deleted in next release, use `TechDocsCustomHome` instead.
- `LegacyTechDocsPage` marked as deprecated and will be deleted in next release, use `TechDocsReaderPage` instead.
.changeset/tough-clocks-enjoy.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-catalog-backend': patch
---
Tweaked the wording of the "does not have a location" errors to include the actual missing annotation name, to help users better in fixing their inputs.
.changeset/tough-pets-beg.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/integration': patch
---
Fix Bitbucket Cloud and Bitbucket Server line number reference.
.changeset/tough-stingrays-sit.md
-5
View File
@@ -1,5 +0,0 @@
---
'@backstage/plugin-catalog-backend': patch
---
Optimized entity provider mutations with large numbers of new additions, such as big initial startup commits
.changeset/twenty-dodos-rule.md
-6
View File
@@ -1,6 +0,0 @@
---
'@backstage/catalog-model': patch
---
Deprecates `EDIT_URL_ANNOTATION`, `LOCATION_ANNOTATION`, `ORIGIN_LOCATION_ANNOTATION`, `SOURCE_LOCATION_ANNOTATION`, `VIEW_URL_ANNOTATION`
and replaces these constants all prefixed with ANNOTATION\_ `ANNOTATION_EDIT_URL`, `ANNOTATION_LOCATION`, `ANNOTATION_ORIGIN_LOCATION`, `ANNOTATION_SOURCE_LOCATION`, `ANNOTATION_VIEW_URL`
.changeset/unlucky-queens-brush.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/core-components': patch
---
Added ability for SidebarSubmenuItem to handle external links correctly via the "to" prop
.changeset/wise-foxes-confess.md
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-scaffolder-backend': patch
---
Fix the support for custom defaultBranch values for Bitbucket Cloud at the `publish:bitbucket` scaffolder action.
.changeset/witty-mails-search.md
-7
View File
@@ -1,7 +0,0 @@
---
'@backstage/plugin-scaffolder-backend-module-cookiecutter': minor
'@backstage/plugin-scaffolder-backend-module-rails': minor
'@backstage/plugin-scaffolder-backend-module-yeoman': minor
---
Updated to the latest version of `@backstage/plugin-scaffolder-backend`, meaning the `TemplateAction` now exposes the precise input type rather than `any`.
.github/styles/vocab.txt
+5
View File
@@ -3,6 +3,8 @@ accessors
addon
addons
Airbrake
Airbrakes
airbrake
Anddddd
Apdex
api
@@ -17,6 +19,7 @@ autoscaling
Autoscaling
autoselect
Avro
aws
backrub
backported
backporting
@@ -275,6 +278,8 @@ sqlite
squidfunk
src
stdout
stringify
stringified
subcomponent
subcomponents
subkey
.github/workflows/ci.yml
-1
View File
@@ -1,5 +1,4 @@
name: CI
on:
pull_request:
paths-ignore:
.github/workflows/deploy_microsite.yml
-1
View File
@@ -1,5 +1,4 @@
name: Deploy Microsite
on:
push:
branches:
.github/workflows/deploy_nightly.yml
-1
View File
@@ -1,5 +1,4 @@
name: Deploy Nightly Release
on:
schedule:
- cron: '0 2 * * *' # run at 2 AM UTC
.github/workflows/deploy_packages.yml
+1 -2
View File
@@ -1,5 +1,4 @@
name: Deploy Packages
on:
workflow_dispatch:
push:
@@ -189,7 +188,7 @@ jobs:
run: yarn tsc:full
- name: build packages
run: yarn lerna -- run --ignore example-app build
run: yarn lerna -- run --ignore example-app --ignore example-backend build
# Publishes current version of packages that are not already present in the registry
- name: publish
.github/workflows/sync_code-formatting.yml
-1
View File
@@ -1,5 +1,4 @@
name: Sync code formatting
on:
push:
branches:
.github/workflows/sync_dependabot-changesets.yml
+1 -1
View File
@@ -2,7 +2,7 @@ name: Sync Dependabot changeset
on:
pull_request_target:
paths:
- .github/workflows/dependabot-changeset-maker.yml
- '.github/workflows/sync_dependabot-changesets.yml'
- '**/yarn.lock'
jobs:
.github/workflows/sync_release-manifest.yml
+1
View File
@@ -5,6 +5,7 @@ on:
version:
description: Version number, without any 'v' prefix
required: true
jobs:
create-new-version:
runs-on: ubuntu-latest
.github/workflows/sync_snyk-github-issues.yml
-1
View File
@@ -1,5 +1,4 @@
name: Sync Snyk GitHub issues
on:
schedule:
- cron: '0 */4 * * *'
.github/workflows/sync_snyk-monitor.yml
+1 -2
View File
@@ -1,11 +1,10 @@
name: Sync Snyk Monitoring
on:
workflow_dispatch:
push:
branches: [master]
paths:
- '.github/workflows/snyk-monitor.yml'
- '.github/workflows/sync_snyk-monitor.yml'
- '**/.snyk'
- '**/package.json'
- 'yarn.lock'
.github/workflows/sync_version-packages.yml
-1
View File
@@ -1,5 +1,4 @@
name: Sync Version Packages PR
on:
push:
branches:
.github/workflows/verify_docs-quality.yml
+1 -1
View File
@@ -1,9 +1,9 @@
name: Verify Docs Quality
on:
pull_request:
branches: [master]
paths:
- '.github/workflows/verify_docs-quality.yml'
- '**.md'
jobs:
.github/workflows/verify_e2e-linux.yml
-1
View File
@@ -1,5 +1,4 @@
name: E2E Test Linux
on:
pull_request:
paths-ignore:
.github/workflows/verify_e2e-techdocs.yml
-1
View File
@@ -1,5 +1,4 @@
name: E2E Test Techdocs
on:
pull_request:
paths-ignore:
.github/workflows/verify_e2e-tugboat.yml
+1
View File
@@ -1,5 +1,6 @@
name: E2E Test Tugboat
on: deployment_status
jobs:
set-pending:
if: github.event.deployment_status.state != 'success' && github.event.deployment_status.state != 'failed'
.github/workflows/verify_e2e-windows.yml
+4 -4
View File
@@ -1,11 +1,11 @@
name: E2E Test Windows
# Building on windows is really slow, so this workflow is separate from e2e.yml and only builds on changes
# to the cli itself. They're more likely to introduce issues on windows, compared to changes to core and yarn.lock.
name: E2E Test Windows
on:
pull_request:
paths:
- '.github/workflows/e2e-win.yml'
- '.github/workflows/verify_e2e-windows.yml'
- 'packages/cli/**'
- 'packages/e2e-test/**'
- 'packages/create-app/**'
@@ -20,7 +20,7 @@ jobs:
strategy:
matrix:
os: [windows-latest]
os: [windows-2019]
node-version: [14.x, 16.x]
env:
.github/workflows/verify_microsite.yml
+1 -2
View File
@@ -1,9 +1,8 @@
name: Verify Microsite
on:
pull_request:
paths:
- '.github/workflows/microsite-build-check.yml'
- '.github/workflows/verify_microsite.yml'
- 'microsite/**'
- 'docs/**'
.github/workflows/verify_storybook.yml
+1 -1
View File
@@ -2,7 +2,7 @@ name: Verify Storybook
on:
pull_request:
paths:
- '.github/workflows/chromatic-storybook-test.yml'
- '.github/workflows/verify_storybook.yml'
- 'storybook/**'
- 'packages/config/src/**'
- 'packages/theme/src/**'
.github/workflows/verify_windows.yml
+4 -2
View File
@@ -1,13 +1,15 @@
name: Verify Master Branch on Windows
on:
workflow_dispatch:
push:
branches: [master]
pull_request:
paths:
- '.github/workflows/verify_windows.yml'
jobs:
build:
runs-on: windows-latest
runs-on: windows-2019
strategy:
matrix:
ADOPTERS.md
+8 -1
View File
@@ -1,3 +1,7 @@
# Adopters
_If you're using Backstage in your organization, please try to add your company name to this list. This really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact._
| Organization | Contact | Description of Use |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Spotify](https://www.spotify.com) | [@leemills83](https://github.com/leemills83) | Main interface towards all of Spotify's infrastructure and technical documentation. |
@@ -74,7 +78,7 @@
| [GoTo](https://www.goto.com) | [Lorenzo Orsatti](https://github.com/lorsatti) | Improve onboarding experience of new developers. Discover faster and painlessly developer documentation, API definitions and team information. Provide useful dev metrics in a central place. Provide easy-to-use templates for new services. |
| [Telstra](https://www.telstra.com.au) | [@kiranpatel11](https://github.com/kiranpatel11), [JasonC](https://github.com/JasonC17) | Primary usage: software catalog and templates<br/> Emerging usage : TechDocs, Explore Ecosystem, TechRadar, etc |
| [Mosaico](https://www.mosaico.com.br/) | [Wédney Yuri](https://github.com/wedneyyuri),[@tino.milton](https://github.com/miltonjacomini) | A centralized service catalog of our documentation for our service engineers. |
| [Mox Bank](https://www.mox.com/) | [Nick Laqua](https://github.com/nick-laqua-dragon) | "Single pane of glass" developer portal for providing a best-in-class developer experience to our product teams and making Mox the best tech environment in Hongkong 🥰🚀 |
| [Mox Bank](https://www.mox.com/) | [Nick Laqua](https://github.com/nick-laqua-dragon) | "Single pane of glass" developer portal for providing a best-in-class developer experience to our product teams and making Mox the best tech environment in Hongkong 🥰🚀 |
| [Keyloop](https://www.keyloop.com/) | [Andre Wanlin](https://github.com/awanlin) | Future-motive Developer Portal to help our teams create technology to make everything about buying and owning a car better. 🚗 |
| [Simply Business](https://sbtech.simplybusiness.co.uk/) | [@addersuk](https://github.com/addersuk), [@LightningStairs](https://github.com/LightningStairs), [@punitcse](https://github.com/punitcse), [@moltenice](https://github.com/moltenice) | Central developer portal to access everything a developer needs such as docs, internal service catalog, and the ability to quickly create a new service from a template. Internally developed Backstage plugins allow us to customise the experience to how we work. |
| [Overwolf](https://www.overwolf.com) | [@tomwolfgang](https://github.com/tomwolfgang) | Dev portal - software catalog, tech-docs, scaffolding |
@@ -93,3 +97,6 @@
| [Invitae](https://www.invitae.com/en) | [@ryan-hanchett](https://github.com/ryan-hanchett), [@gmandler42](https://github.com/gmandler42) | Centralized Developer Experience portal, putting all of our tooling behind a single pane of glass and creating a living service catalog. |
| [Fortum](https://www.fortum.com/) | [@brunoamaroalmeida](https://github.com/brunoamaroalmeida), [@dhaval-vithalani](https://github.com/dhaval-vithalani), [@sunilkumarmohanty](https://github.com/sunilkumarmohanty) | A central portal containing information about our applications, services, processes and other software assets to be used by Fortum software engineering community. |
| [Procore](https://www.procore.com/jobs/engineering) | [@shayon](https://github.com/Shayon), [@jamesdabbs-procore](https://github.com/jamesdabbs-procore) | Developer portal - centralized software catalog and templates to enable self serve and reduce cognitive load. |
| [Bradesco](https://banco.bradesco/html/classic/sobre/index.shtm) | [@danilosoarescardoso](https://github.com/danilosoarescardoso) | Centralized developer portal with software catalog, software templates, techdocs and some plugins from community and by our own. |
| [SeatGeek](https://seatgeek.com) | [@zhammer](https://github.com/zhammer) | Software catalog and documentation platform |
| [Grupo Boticário](https://www.grupoboticario.com.br/) | [@chicoribas](https://github.com/chicoribas), [@fndiaz](https://github.com/fndiaz), [@digogid](https://github.com/digogid), [@manumbs](https://github.com/manumbs), [@haooliveira84](https://github.com/haooliveira84), [@Rhullyam](https://github.com/Rhullyam) | Centralized developer portal with catalog, documentation, and software templates to build a ready to go application, including pipelines (CI/CD) and cloud services provisioning |
CONTRIBUTING.md
+2 -2
View File
@@ -2,7 +2,7 @@
Our vision for Backstage is for it to become the trusted standard toolbox (read: UX layer) for the open source infrastructure landscape. Think of it like Kubernetes for developer experience. We realize this is an ambitious goal. We can’t do it alone.
Therefore we want to create strong community of contributors -- all working together to create the kind of delightful experience that our developers deserve.
Therefore we want to create a strong community of contributors -- all working together to create the kind of delightful experience that our developers deserve.
Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given. ❤️
@@ -100,7 +100,7 @@ Signed-off-by: Jane Smith <jane.smith@example.com>
- In case you forgot to add it to the last N commits in your branch, use `git rebase --signoff HEAD~N` and replace N with the number of new commits you created in your branch.
- If you have a very deep branch with a lot of commits, run `git rebase -i --signoff $(git merge-base -a master HEAD)`, double check to make sense of the commits (keep all lines as `pick`) and save and close the editor. This should bulk sign all the commits in your PR. Do be careful though. If you have a complex flow with a lot of branching and re-merging of work branches and stuff, merge-base may not be the right solution for you.
Note: If you have already pushed you branch to a remote, you might have to force push: `git push -f` after the rebase.
Note: If you have already pushed your branch to a remote, you might have to force push: `git push -f` after the rebase.
### Using GitHub Desktop?
GOVERNANCE.md
+1 -1
View File
@@ -24,7 +24,7 @@ To become a maintainer you need to demonstrate the following:
- Monitor Discord (delayed response is perfectly acceptable).
- Triage GitHub issues and perform pull request reviews for other maintainers and the community.
- Triage build issues - file issues for known flaky builds or bugs, and either fix or find someone to fix any master build breakages.
- During GitHub issue triage, apply all applicable ([labels](https://github.com/backstage/backstage/labels)) to each new issue. Labels are extremely useful for future issue follow up. Which labels to apply is somewhat subjective so just use your best judgment. A few of the most important labels that are not self explanatory are:
- During GitHub issue triage, apply all applicable ([labels](https://github.com/backstage/backstage/labels)) to each new issue. Labels are extremely useful for future issue follow-up. Which labels to apply is somewhat subjective so just use your best judgment. A few of the most important labels that are not self-explanatory are:
- good first issue: Mark any issue that can reasonably be accomplished by a new contributor with this label.
- help wanted: Unless it is immediately obvious that someone is going to work on an issue (and if so assign it), mark it help wanted.
- Make sure that ongoing PRs are moving forward at the right pace or closing them.
STYLE.md
+2 -2
View File
@@ -131,7 +131,7 @@ We use [API Extractor](https://api-extractor.com/pages/overview/demo_docs/) to g
The doc comments are of the good old `/** ... */` format, with tags of the format `@<tag>` used to mark various things. The [TSDoc website](https://tsdoc.org/) has a good index of all available tags.
There are a few things to pay attention to make the documentation show up in a nice way on the website...
There are a few things to pay attention to, in order to make the documentation show up in a nice way on the website...
## Declare exported functions using the `function` keyword
@@ -163,7 +163,7 @@ If the parameters of a function are destructed in the parameter list, they will
![image](https://user-images.githubusercontent.com/4984472/133117011-3e6cb6da-40dd-450e-8d33-51bdcf412e08.png)
Instead prefer to use a single parameter variable and then move the destructuring into the function body instead, which will look much nicer:
Instead prefer to use a single parameter variable and then move the destructuring into the function body, which will look much nicer:
![image](https://user-images.githubusercontent.com/4984472/133120542-d648de43-5495-43a8-b532-f5e6f6ab736e.png)
app-config.yaml
-8
View File
@@ -211,14 +211,6 @@ catalog:
- Location
processors:
githubOrg:
providers:
- target: https://github.com
token: ${GITHUB_TOKEN}
#### Example for how to add your GitHub Enterprise instance using the API:
# - target: https://ghe.example.net
# apiBaseUrl: https://ghe.example.net/api
# token: ${GHE_TOKEN}
ldapOrg:
### Example for how to add your enterprise LDAP server
# providers:
contrib/chart/backstage/templates/ingress.yaml
-1
View File
@@ -15,7 +15,6 @@ metadata:
{{- if .Values.issuer.email }}
cert-manager.io/cluster-issuer: {{ .Values.issuer.clusterIssuer }}
{{- end }}
kubernetes.io/ingress.class: nginx
nginx.ingress.kubernetes.io/ssl-redirect: "false"
nginx.ingress.kubernetes.io/configuration-snippet: |
if ($scheme = https) {
contrib/docs/tutorials/aws-alb-aad-oidc-auth.md
+4 -4
View File
@@ -182,12 +182,12 @@ Use the following `auth` configuration when running Backstage on AWS:
auth:
providers:
awsalb:
issuer:
issuer: https://login.microsoftonline.com/{TENANT_ID}/v2.0
region: { AWS_REGION }
development:
issuer: https://login.microsoftonline.com/<TENANT_ID>/v2.0
region: <AWS_REGION>
```
Replace `{TENANT_ID}` with the value of `Directory (tenant) ID` of the AAD App and `{AWS_REGION}` with the AWS region identifier where the ALB is deployed (for example: `eu-central-1`).
Replace `<TENANT_ID>` with the value of `Directory (tenant) ID` of the AAD App and `<AWS_REGION>` with the AWS region identifier where the ALB is deployed (for example: `eu-central-1`).
## Conclusion
docs/assets/getting-started/sidebar-with-catalog.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 18 KiB

docs/assets/getting-started/sidebar-without-catalog.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

docs/assets/getting-started/simple-homepage.png
BIN
View File
Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 78 KiB

docs/auth/bitbucket/provider.md
+1 -1
View File
@@ -67,7 +67,7 @@ Bitbucket username to `bitbucket.org/username` annotations of `User` entities in
the catalog. Note that you must populate your catalog with matching entities or
users will not be able to sign in.
The second resolver is the `bitbucketUsernameSignInResolver`, which works the
The second resolver is the `bitbucketUserIdSignInResolver`, which works the
same way, but uses the Bitbucket user ID instead, and matches on the
`bitbucket.org/user-id` annotation.

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