fix(user-settings): enhance build-info config to make it intuitive

.ibm/pipelines/resources/config_map/app-config-rhdh.yaml

@@ -226,4 +226,4 @@ buildInfo:
     TechDocs builder: "local"
     Authentication provider: "Github"
     RBAC: disabled
-  full: true
+  overrideBuildInfo: true

docs/customization.md

@@ -194,7 +194,7 @@ buildInfo:
     TechDocs builder: 'local'
     Authentication provider: 'Github'
     RBAC: disabled
-  full: true # If set to true, only the information specified in this configuration will be displayed. If set to false, the provided details will be shown along with the build versions. By default it will only display the configured information.
+  overrideBuildInfo: true # If set to true, only the information specified in this configuration will be displayed. If set to false, the provided details will be shown along with the build versions. By default it will only display the configured information.
 ```
 
 ## Customizing the Language dropdown

packages/app/config.d.ts

@@ -258,13 +258,27 @@ export interface Config {
   includeTransitiveGroupOwnership?: boolean;
 
   /**
-   * Allows you to customize RHDH Metadata card
+   * Allows you to customize RHDH Metadata card information
    * @deepVisibility frontend
    */
   buildInfo?: {
+    /**
+     * Allows setting a title for the build information card
+     * @visibility frontend
+     */
     title: string;
+    /**
+     * Allows setting a content for the build information card
+     * @visibility frontend
+     */
     card: { [key: string]: string };
-    full?: boolean;
+    /**
+     * Allows setting if the default build information (RHDH Version, Backstage Version, etc.) should be overridden
+     * Contents will be overridden if not set to false
+     * @default true
+     * @visibility frontend
+     */
+    overrideBuildInfo?: boolean;
   };
 
   /**

packages/app/src/components/UserSettings/InfoCard.test.tsx

@@ -78,7 +78,7 @@ describe('InfoCard', () => {
             'Authentication provider': 'Github',
             RBAC: 'disabled',
           },
-          full: false,
+          overrideBuildInfo: false,
         },
       },
     });
@@ -107,7 +107,7 @@ describe('InfoCard', () => {
             'Authentication provider': 'Github',
             RBAC: 'disabled',
           },
-          full: true,
+          overrideBuildInfo: true,
         },
       },
     });

packages/app/src/components/UserSettings/InfoCard.tsx

@@ -40,7 +40,8 @@ export const InfoCard = () => {
 
   let clipboardText = title;
   const buildDetails = Object.entries(
-    buildInfo?.full === false // append build versions to the object only when buildInfo.full === false
+    buildInfo?.full === false || // make it backward compatible with previous `full` config option
+      buildInfo?.overrideBuildInfo === false
       ? { ...buildInfo?.card, ...buildMetadata?.card }
       : (buildInfo?.card ?? buildMetadata?.card),
   ).map(([key, value]) => `${key}: ${value}`);

packages/app/src/types/types.ts

@@ -13,6 +13,7 @@ export type BuildInfo = {
   title: string;
   card: { [key: string]: string };
   full?: boolean;
+  overrideBuildInfo?: boolean;
 };
 
 export type TranslationConfig = {