@backstage/create-app 0.0.0-nightly-20220610024824 → 0.0.0-nightly-20220613024651

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @backstage/create-app
 
-## 0.0.0-nightly-20220610024824
+## 0.0.0-nightly-20220613024651
 
 ### Patch Changes
 
@@ -102,6 +102,67 @@
   };
   ```
 
+- 30f04d1497: Components `<DefaultResultListItem>`, `<SearchBar>`, `<SearchFilter>`, and `<SearchResult>` are now deprecated in `@backstage/plugin-search` and should be imported from `@backstage/plugin-search-react` instead.
+
+  To upgrade your App, update the following in `packages/app/src/components/search/SearchPage.tsx`:
+
+  ```diff
+  import {
+    DefaultResultListItem
+    SearchBar
+    SearchFilter
+    SearchResult
+  - } from `@backstage/plugin-search`;
+  + } from `@backstage/plugin-search-react`;
+  ```
+
+- f7f5a6c6a3: It's now possible to pass result item components a `rank`, which is captured by the analytics API when a user clicks on a search result. To apply this change, update your `/packages/app/src/components/search/SearchPage.tsx` in the following way:
+
+  ```diff
+  // ...
+  <SearchResult>
+    {({ results }) => (
+      <List>
+  -     {results.map(({ type, document, highlight }) => {
+  +     {results.map(({ type, document, highlight, rank }) => {
+          switch (type) {
+            case 'software-catalog':
+              return (
+                <CatalogSearchResultListItem
+                  key={document.location}
+                  result={document}
+                  highlight={highlight}
+  +               rank={rank}
+                />
+              );
+            case 'techdocs':
+              return (
+                <TechDocsSearchResultListItem
+                  key={document.location}
+                  result={document}
+                  highlight={highlight}
+  +               rank={rank}
+                />
+              );
+            default:
+              return (
+                <DefaultResultListItem
+                  key={document.location}
+                  result={document}
+                  highlight={highlight}
+  +               rank={rank}
+                />
+              );
+          }
+        })}
+      </List>
+    )}
+  </SearchResult>
+  // ...
+  ```
+
+  If you have implemented a custom Search Modal or other custom search experience, you will want to make similar changes in those components.
+
 - aaf7652084: Bump version of `cypress` in newly scaffolded Backstage Applications. To apply this change to your own instance, please make the following change to `packages/app/package.json` under `devDependencies`.
 
   ```diff
@@ -109,6 +170,8 @@
   +   "cypress": "^9.7.0",
   ```
 
+- 141a1caebe: Updated the auth backend setup in the template to include a guest sign-in resolver in order to make it quicker to get up and running with a basic sign-in setup. There is no need to update existing apps to match this change, but in case you want to use the guest sign-in resolver you can find it at https://backstage.io/docs/auth/identity-resolver#guest-sign-in-resolver
+
 ## 0.4.28-next.2
 
 ### Patch Changes

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/create-app",
   "description": "A CLI that helps you create your own Backstage app",
-  "version": "0.0.0-nightly-20220610024824",
+  "version": "0.0.0-nightly-20220613024651",
   "private": false,
   "publishConfig": {
     "access": "public"

package/templates/default-app/packages/app/src/components/search/SearchPage.tsx

@@ -8,14 +8,14 @@ import {
 } from '@backstage/plugin-catalog-react';
 import { TechDocsSearchResultListItem } from '@backstage/plugin-techdocs';
 
+import { SearchType } from '@backstage/plugin-search';
 import {
+  DefaultResultListItem,
   SearchBar,
   SearchFilter,
   SearchResult,
-  SearchType,
-  DefaultResultListItem,
-} from '@backstage/plugin-search';
-import { useSearch } from '@backstage/plugin-search-react';
+  useSearch,
+} from '@backstage/plugin-search-react';
 import {
   CatalogIcon,
   Content,
@@ -112,7 +112,7 @@ const SearchPage = () => {
             <SearchResult>
               {({ results }) => (
                 <List>
-                  {results.map(({ type, document, highlight }) => {
+                  {results.map(({ type, document, highlight, rank }) => {
                     switch (type) {
                       case 'software-catalog':
                         return (
@@ -120,6 +120,7 @@ const SearchPage = () => {
                             key={document.location}
                             result={document}
                             highlight={highlight}
+                            rank={rank}
                           />
                         );
                       case 'techdocs':
@@ -128,6 +129,7 @@ const SearchPage = () => {
                             key={document.location}
                             result={document}
                             highlight={highlight}
+                            rank={rank}
                           />
                         );
                       default:
@@ -136,6 +138,7 @@ const SearchPage = () => {
                             key={document.location}
                             result={document}
                             highlight={highlight}
+                            rank={rank}
                           />
                         );
                     }

package/templates/default-app/packages/backend/src/plugins/auth.ts

@@ -18,18 +18,36 @@ export default async function createPlugin(
     providerFactories: {
       ...defaultAuthProviderFactories,
 
-      // This overrides the default GitHub auth provider with a custom one.
-      // Since the options are empty it will behave just like the default
-      // provider, but if you uncomment the `signIn` section you will enable
-      // sign-in via GitHub. This particular configuration uses a resolver
-      // that matches the username to the user entity name. See the auth
-      // documentation for more details on how to enable and customize sign-in:
+      // This replaces the default GitHub auth provider with a customized one.
+      // The `signIn` option enables sign-in for this provider, using the
+      // identity resolution logic that's provided in the `resolver` callback.
+      //
+      // This particular resolver makes all users share a single "guest" identity.
+      // It should only be used for testing and trying out Backstage.
+      //
+      // If you want to use a production ready resolver you can switch to the
+      // the one that is commented out below, it looks up a user entity in the
+      // catalog using the GitHub username of the authenticated user.
+      // That resolver requires you to have user entities populated in the catalog,
+      // for example using https://backstage.io/docs/integrations/github/org
+      //
+      // There are other resolvers to choose from, and you can also create
+      // your own, see the auth documentation for more details:
       //
       //   https://backstage.io/docs/auth/identity-resolver
       github: providers.github.create({
-        // signIn: {
-        //   resolver: providers.github.resolvers.usernameMatchingUserEntityName(),
-        // },
+        signIn: {
+          resolver(_, ctx) {
+            const userRef = 'user:default/guest'; // Must be a full entity reference
+            return ctx.issueToken({
+              claims: {
+                sub: userRef, // The user's own identity
+                ent: [userRef], // A list of identities that the user claims ownership through
+              },
+            });
+          },
+          // resolver: providers.github.resolvers.usernameMatchingUserEntityName(),
+        },
       }),
     },
   });