Merge branch 'master' of github.com:backstage/backstage into catalog-import-instructions

.changeset/grumpy-meals-wink.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-catalog-import': patch
+---
+
+Align plugin ID and fix variable typo

.changeset/perfect-donkeys-hope.md

@@ -0,0 +1,5 @@
+---
+'@backstage/cli': patch
+---
+
+Fix config schema for `.app.listen`

.changeset/purple-ghosts-attack.md

@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-search': patch
+---
+
+change default size for pageSize in search result view

.changeset/shaggy-camels-remain.md

@@ -0,0 +1,8 @@
+---
+'example-backend': patch
+'@backstage/plugin-scaffolder-backend': patch
+'@backstage/plugin-techdocs-backend': patch
+'@backstage/create-app': patch
+---
+
+Unify `dockerode` library and type dependency versions

.changeset/unlucky-kiwis-rescue.md

@@ -0,0 +1,14 @@
+---
+'@backstage/core': minor
+---
+
+Introducing a new optional property within `app-config.yaml` called `auth.environment` to have configurable environment value for `auth.providers`
+
+**Default Value:** 'development'
+
+**Optional Values:** 'production' | 'development'
+
+**Migration-steps:**
+
+- To override the default value, one could simply introduce the new property `environment` within the `auth` section of the `config.yaml`
+- re-run the build to reflect the changed configs

CHANGELOG.md

@@ -1,13 +1,9 @@
 # Backstage Changelog
 
-This is a best-effort changelog where we manually collect breaking changes. It is not an exhaustive list of all changes or even features added.
+This changelog is no longer being updated and will be removed in the future, as each package now has its own changelog instead. It was a best-effort changelog where we manually collected breaking changes during the `v0.1.1-alpha.<n>` releases.
 
 If you encounter issues while upgrading to a newer version, don't hesitate to reach out on [Discord](https://discord.gg/EBHEGzX) or [open an issue](https://github.com/backstage/backstage/issues/new/choose)!
 
-## Next Release
-
-> Collect changes for the next release below
-
 ## v0.1.1-alpha.26
 
 ### @backstage/cli

app-config.yaml

@@ -190,6 +190,7 @@ scaffolder:
       token:
         $env: AZURE_TOKEN
 auth:
+  environment: development
   ### Providing an auth.session.secret will enable session support in the auth-backend
   # session:
   #   secret: custom session secret

packages/backend-common/src/reading/GithubUrlReader.ts

@@ -196,6 +196,7 @@ export class GithubUrlReader implements UrlReader {
       new URL(
         `${protocol}://${resource}/${full_name}/archive/${ref}.tar.gz`,
       ).toString(),
+      getRawRequestOptions(this.config),
     );
     if (!response.ok) {
       const message = `Failed to read tree from ${url}, ${response.status} ${response.statusText}`;

packages/backend/package.json

@@ -34,7 +34,7 @@
     "@gitbeaker/node": "^25.2.0",
     "@octokit/rest": "^18.0.0",
     "azure-devops-node-api": "^10.1.1",
-    "dockerode": "^3.2.0",
+    "dockerode": "^3.2.1",
     "example-app": "^0.2.5",
     "express": "^4.17.1",
     "express-promise-router": "^3.0.3",
@@ -46,7 +46,7 @@
   },
   "devDependencies": {
     "@backstage/cli": "^0.4.0",
-    "@types/dockerode": "^2.5.32",
+    "@types/dockerode": "^3.2.1",
     "@types/express": "^4.17.6",
     "@types/express-serve-static-core": "^4.17.5",
     "@types/helmet": "^0.0.48"

packages/cli/package.json

@@ -178,7 +178,7 @@
             "description": "Listening configuration for local development",
             "properties": {
               "host": {
-                "type": "number",
+                "type": "string",
                 "visibility": "frontend",
                 "description": "The host that the frontend should be bound to. Only used for local development."
               },

packages/core/config.d.ts

@@ -62,4 +62,17 @@ export interface Config {
       timezone: string;
     }[];
   };
+
+  /**
+   * Configuration that provides information on available authentication providers configured for app
+   */
+  auth?: {
+    /**
+     * The 'environment' attribute added as an optional parameter to have configurable environment value for `auth.providers`.
+     * default value: 'development'
+     * optional values: 'development' | 'production'
+     * @visibility frontend
+     */
+    environment?: string;
+  };
 }

packages/core/src/api-wrappers/defaultApis.ts

@@ -78,30 +78,42 @@ export const defaultApis = [
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
-      GoogleAuth.create({ discoveryApi, oauthRequestApi }),
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      GoogleAuth.create({
+        discoveryApi,
+        oauthRequestApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: microsoftAuthApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
-      MicrosoftAuth.create({ discoveryApi, oauthRequestApi }),
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      MicrosoftAuth.create({
+        discoveryApi,
+        oauthRequestApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: githubAuthApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
       GithubAuth.create({
         discoveryApi,
         oauthRequestApi,
         defaultScopes: ['read:user'],
+        environment: configApi.getOptionalString('auth.environment'),
       }),
   }),
   createApiFactory({
@@ -109,60 +121,91 @@ export const defaultApis = [
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
-      OktaAuth.create({ discoveryApi, oauthRequestApi }),
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      OktaAuth.create({
+        discoveryApi,
+        oauthRequestApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: gitlabAuthApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
-      GitlabAuth.create({ discoveryApi, oauthRequestApi }),
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      GitlabAuth.create({
+        discoveryApi,
+        oauthRequestApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: auth0AuthApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
-      Auth0Auth.create({ discoveryApi, oauthRequestApi }),
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      Auth0Auth.create({
+        discoveryApi,
+        oauthRequestApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: oauth2ApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
-      OAuth2.create({ discoveryApi, oauthRequestApi }),
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      OAuth2.create({
+        discoveryApi,
+        oauthRequestApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: samlAuthApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi }) => SamlAuth.create({ discoveryApi }),
+    factory: ({ discoveryApi, configApi }) =>
+      SamlAuth.create({
+        discoveryApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: oneloginAuthApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
-      OneLoginAuth.create({ discoveryApi, oauthRequestApi }),
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
+      OneLoginAuth.create({
+        discoveryApi,
+        oauthRequestApi,
+        environment: configApi.getOptionalString('auth.environment'),
+      }),
   }),
   createApiFactory({
     api: oidcAuthApiRef,
     deps: {
       discoveryApi: discoveryApiRef,
       oauthRequestApi: oauthRequestApiRef,
+      configApi: configApiRef,
     },
-    factory: ({ discoveryApi, oauthRequestApi }) =>
+    factory: ({ discoveryApi, oauthRequestApi, configApi }) =>
       OAuth2.create({
         discoveryApi,
         oauthRequestApi,
@@ -171,6 +214,7 @@ export const defaultApis = [
           title: 'Your Identity Provider',
           icon: OAuth2Icon,
         },
+        environment: configApi.getOptionalString('auth.environment'),
       }),
   }),
 ];

packages/create-app/templates/default-app/packages/backend/package.json.hbs

@@ -29,7 +29,7 @@
     "@backstage/plugin-techdocs-backend": "^{{version '@backstage/plugin-techdocs-backend'}}",
     "@octokit/rest": "^18.0.0",
     "@gitbeaker/node": "^25.2.0",
-    "dockerode": "^3.2.0",
+    "dockerode": "^3.2.1",
     "express": "^4.17.1",
     "express-promise-router": "^3.0.3",
     "knex": "^0.21.6",
@@ -43,7 +43,7 @@
   },
   "devDependencies": {
     "@backstage/cli": "^{{version '@backstage/cli'}}",
-    "@types/dockerode": "^2.5.32",
+    "@types/dockerode": "^3.2.1",
     "@types/express": "^4.17.6",
     "@types/express-serve-static-core": "^4.17.5",
     "@types/helmet": "^0.0.47"

plugins/catalog-import/src/api/CatalogImportApi.ts

@@ -18,7 +18,7 @@ import { createApiRef } from '@backstage/core';
 import { PartialEntity } from '../util/types';
 
 export const catalogImportApiRef = createApiRef<CatalogImportApi>({
-  id: 'plugin.catalogimport.service',
+  id: 'plugin.catalog-import.service',
   description: 'Used by the catalog import plugin to make requests',
 });
 

plugins/catalog-import/src/api/CatalogImportClient.ts

@@ -160,7 +160,7 @@ export class CatalogImportClient implements CatalogImportApi {
         );
       });
 
-    const pullRequestRespone = await octo.pulls
+    const pullRequestResponse = await octo.pulls
       .create({
         owner,
         repo,
@@ -178,7 +178,7 @@ export class CatalogImportClient implements CatalogImportApi {
       });
 
     return {
-      link: pullRequestRespone.data.html_url,
+      link: pullRequestResponse.data.html_url,
       location: `https://github.com/${owner}/${repo}/blob/${repoData.data.default_branch}/${fileName}`,
     };
   }

plugins/scaffolder-backend/package.json

@@ -26,13 +26,13 @@
     "@gitbeaker/core": "^25.2.0",
     "@gitbeaker/node": "^25.2.0",
     "@octokit/rest": "^18.0.0",
-    "@types/dockerode": "^2.5.32",
+    "@types/dockerode": "^3.2.1",
     "@types/express": "^4.17.6",
     "azure-devops-node-api": "^10.1.1",
     "command-exists-promise": "^2.0.2",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
-    "dockerode": "^3.2.0",
+    "dockerode": "^3.2.1",
     "express": "^4.17.1",
     "express-promise-router": "^3.0.3",
     "fs-extra": "^9.0.0",

plugins/search/src/components/SearchResult/SearchResult.tsx

@@ -251,7 +251,7 @@ export const SearchResult = ({ searchQuery }: SearchResultProps) => {
         )}
         <Grid item xs={showFilters ? 9 : 12}>
           <Table
-            options={{ paging: true, search: false }}
+            options={{ paging: true, pageSize: 20, search: false }}
             data={filteredResults}
             columns={columns}
             title={

plugins/techdocs-backend/package.json

@@ -23,7 +23,7 @@
     "@backstage/backend-common": "^0.3.3",
     "@backstage/catalog-model": "^0.4.0",
     "@backstage/config": "^0.1.1",
-    "@types/dockerode": "^2.5.34",
+    "@types/dockerode": "^3.2.1",
     "@types/express": "^4.17.6",
     "command-exists-promise": "^2.0.2",
     "cross-fetch": "^3.0.6",

yarn.lock

@@ -1316,7 +1316,18 @@
     to-fast-properties "^2.0.0"
 
 "@backstage/catalog-model@^0.2.0":
-  version "0.3.1"
+  version "0.4.0"
+  dependencies:
+    "@backstage/config" "^0.1.1"
+    "@types/json-schema" "^7.0.5"
+    "@types/yup" "^0.29.8"
+    json-schema "^0.2.5"
+    lodash "^4.17.15"
+    uuid "^8.0.0"
+    yup "^0.29.3"
+
+"@backstage/catalog-model@^0.3.0":
+  version "0.4.0"
   dependencies:
     "@backstage/config" "^0.1.1"
     "@types/json-schema" "^7.0.5"
@@ -1800,11 +1811,11 @@
     yaml-ast-parser "0.0.43"
 
 "@gitbeaker/core@^25.2.0":
-  version "25.2.0"
-  resolved "https://registry.npmjs.org/@gitbeaker/core/-/core-25.2.0.tgz#c2f46b65ed88aebfa69afd2e58dbf4ebe2efb2c7"
-  integrity sha512-dhCvZItI8FIzHtJ9EySQ43GmNg3j39MxDGMCpDHn+Qb1o54QS+J6XPVQrMRmJioZIyj+WZQPX/IP+/mRkx8vhg==
+  version "25.6.0"
+  resolved "https://registry.npmjs.org/@gitbeaker/core/-/core-25.6.0.tgz#97d5ccc5d61bab6b678bec280036d594d275931e"
+  integrity sha512-+CohJNsbZiPl7jPgw7PHt5t0JIIV9NngObOskY1Ww8jef7SqaKpz0NsbSDawuWFBdmXApMpK81AEfASKtVI+cw==
   dependencies:
-    "@gitbeaker/requester-utils" "^25.2.0"
+    "@gitbeaker/requester-utils" "^25.6.0"
     form-data "^3.0.0"
     li "^1.3.0"
     xcase "^2.0.1"
@@ -1819,10 +1830,10 @@
     got "^11.7.0"
     xcase "^2.0.1"
 
-"@gitbeaker/requester-utils@^25.2.0":
-  version "25.2.0"
-  resolved "https://registry.npmjs.org/@gitbeaker/requester-utils/-/requester-utils-25.2.0.tgz#f71c44e0073617877f9875dd00c4ae0d74897b09"
-  integrity sha512-pjuFIVlbxSTPdN+zFT/LBP4ym8k0OBYwUpc5WkzoOtvdTGuDX05r8ufnV07kibLDJkwDmjwnH4Hsc66yevSQTw==
+"@gitbeaker/requester-utils@^25.2.0", "@gitbeaker/requester-utils@^25.6.0":
+  version "25.6.0"
+  resolved "https://registry.npmjs.org/@gitbeaker/requester-utils/-/requester-utils-25.6.0.tgz#001a432a48460bb5196a02ed71763eb707a1a01e"
+  integrity sha512-jD8cHbAZPR6+cB3HiukQxcqIKF5VkHtqg2m+Ns6ROE1pb0oRn10D/a9J1lZOXC9Jz2tQOBMWfHlplbmFFdB6Og==
   dependencies:
     form-data "^3.0.0"
     query-string "^6.13.3"
@@ -5169,10 +5180,10 @@
   resolved "https://registry.npmjs.org/@types/diff/-/diff-4.0.2.tgz#2e9bb89f9acc3ab0108f0f3dc4dbdcf2fff8a99c"
   integrity sha512-mIenTfsIe586/yzsyfql69KRnA75S8SVXQbTLpDejRrjH0QSJcpu3AUOi/Vjnt9IOsXKxPhJfGpQUNMueIU1fQ==
 
-"@types/dockerode@^2.5.32", "@types/dockerode@^2.5.34":
-  version "2.5.34"
-  resolved "https://registry.npmjs.org/@types/dockerode/-/dockerode-2.5.34.tgz#9adb884f7cc6c012a6eb4b2ad794cc5d01439959"
-  integrity sha512-LcbLGcvcBwBAvjH9UrUI+4qotY+A5WCer5r43DR5XHv2ZIEByNXFdPLo1XxR+v/BjkGjlggW8qUiXuVEhqfkpA==
+"@types/dockerode@^3.2.1":
+  version "3.2.1"
+  resolved "https://registry.npmjs.org/@types/dockerode/-/dockerode-3.2.1.tgz#f713a8f6f1017c227845ab33239383da721207b9"
+  integrity sha512-AeZpdQMNqM8dtrEaaP81CbjdRVKNmFIMzgz5IlKIeS5uWEmjlEmENP444AGTEEF71r5TFuY9E4SkzZAO8lOF1A==
   dependencies:
     "@types/node" "*"
 
@@ -8666,9 +8677,9 @@ chokidar@^2.1.8:
     fsevents "^1.2.7"
 
 chokidar@^3.2.2, chokidar@^3.3.0, chokidar@^3.3.1, chokidar@^3.4.1, chokidar@^3.4.2:
-  version "3.4.2"
-  resolved "https://registry.npmjs.org/chokidar/-/chokidar-3.4.2.tgz#38dc8e658dec3809741eb3ef7bb0a47fe424232d"
-  integrity sha512-IZHaDeBeI+sZJRX7lGcXsdzgvZqKv6sECqsbErJA4mHWfpRrD8B97kSFN4cQz6nGBGiuFia1MKR4d6c1o8Cv7A==
+  version "3.4.3"
+  resolved "https://registry.npmjs.org/chokidar/-/chokidar-3.4.3.tgz#c1df38231448e45ca4ac588e6c79573ba6a57d5b"
+  integrity sha512-DtM3g7juCXQxFVSNPNByEC2+NImtBuxQQvWlHunpJIS5Ocr0lG306cC7FCi7cEA0fzmybPUIl4txBIobk1gGOQ==
   dependencies:
     anymatch "~3.1.1"
     braces "~3.0.2"
@@ -8676,7 +8687,7 @@ chokidar@^3.2.2, chokidar@^3.3.0, chokidar@^3.3.1, chokidar@^3.4.1, chokidar@^3.
     is-binary-path "~2.1.0"
     is-glob "~4.0.1"
     normalize-path "~3.0.0"
-    readdirp "~3.4.0"
+    readdirp "~3.5.0"
   optionalDependencies:
     fsevents "~2.1.2"
 
@@ -10629,7 +10640,7 @@ docker-modem@^2.1.0:
     split-ca "^1.0.1"
     ssh2 "^0.8.7"
 
-dockerode@^3.2.0, dockerode@^3.2.1:
+dockerode@^3.2.1:
   version "3.2.1"
   resolved "https://registry.npmjs.org/dockerode/-/dockerode-3.2.1.tgz#4a2222e3e1df536bf595e78e76d3cfbf6d4d93b9"
   integrity sha512-XsSVB5Wu5HWMg1aelV5hFSqFJaKS5x1aiV/+sT7YOzOq1IRl49I/UwV8Pe4x6t0iF9kiGkWu5jwfvbkcFVupBw==
@@ -20630,10 +20641,10 @@ readdirp@^2.2.1:
     micromatch "^3.1.10"
     readable-stream "^2.0.2"
 
-readdirp@~3.4.0:
-  version "3.4.0"
-  resolved "https://registry.npmjs.org/readdirp/-/readdirp-3.4.0.tgz#9fdccdf9e9155805449221ac645e8303ab5b9ada"
-  integrity sha512-0xe001vZBnJEK+uKcj8qOhyAKPzIT+gStxWr3LCB0DwcXR5NZJ3IaC+yGnHCYzB/S7ov3m3EEbZI2zeNvX+hGQ==
+readdirp@~3.5.0:
+  version "3.5.0"
+  resolved "https://registry.npmjs.org/readdirp/-/readdirp-3.5.0.tgz#9ba74c019b15d365278d2e91bb8c48d7b4d42c9e"
+  integrity sha512-cMhu7c/8rdhkHXWsY+osBhfSy0JikwpHK/5+imo+LpeasTF8ouErHrlYkwT0++njiyuDvc7OFY5T3ukvZ8qmFQ==
   dependencies:
     picomatch "^2.2.1"