Merge pull request #2195 from spotify/rugvip/buildinfo

cli: define BUILD_INFO in builds

packages/cli/src/lib/bundler/bundle.ts

@@ -36,7 +36,7 @@ export async function buildBundle(options: BuildOptions) {
   const { statsJsonEnabled } = options;
 
   const paths = resolveBundlingPaths(options);
-  const config = createConfig(paths, {
+  const config = await createConfig(paths, {
     ...options,
     checksEnabled: false,
     isDev: false,

packages/cli/src/lib/bundler/config.ts

@@ -14,6 +14,7 @@
  * limitations under the License.
  */
 
+import fs from 'fs-extra';
 import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
 import HtmlWebpackPlugin from 'html-webpack-plugin';
 import ModuleScopePlugin from 'react-dev-utils/ModuleScopePlugin';
@@ -25,6 +26,9 @@ import { Config } from '@backstage/config';
 import { BundlingPaths } from './paths';
 import { transforms } from './transforms';
 import { BundlingOptions, BackendBundlingOptions } from './types';
+import { version } from '../../lib/version';
+import { paths as cliPaths } from '../../lib/paths';
+import { runPlain } from '../run';
 
 export function resolveBaseUrl(config: Config): URL {
   const baseUrl = config.getString('app.baseUrl');
@@ -35,10 +39,40 @@ export function resolveBaseUrl(config: Config): URL {
   }
 }
 
-export function createConfig(
+async function readBuildInfo() {
+  const timestamp = Date.now();
+
+  let commit = 'unknown';
+  try {
+    commit = await runPlain('git', 'rev-parse', 'HEAD');
+  } catch (error) {
+    console.warn(`WARNING: Failed to read git commit, ${error}`);
+  }
+
+  let gitVersion = 'unknown';
+  try {
+    gitVersion = await runPlain('git', 'describe', '--always');
+  } catch (error) {
+    console.warn(`WARNING: Failed to describe git version, ${error}`);
+  }
+
+  const { version: packageVersion } = await fs.readJson(
+    cliPaths.resolveTarget('package.json'),
+  );
+
+  return {
+    cliVersion: version,
+    gitVersion,
+    packageVersion,
+    timestamp,
+    commit,
+  };
+}
+
+export async function createConfig(
   paths: BundlingPaths,
   options: BundlingOptions,
-): webpack.Configuration {
+): Promise<webpack.Configuration> {
   const { checksEnabled, isDev } = options;
 
   const { plugins, loaders } = transforms(options);
@@ -81,6 +115,13 @@ export function createConfig(
     }),
   );
 
+  const buildInfo = await readBuildInfo();
+  plugins.push(
+    new webpack.DefinePlugin({
+      'process.env.BUILD_INFO': JSON.stringify(buildInfo),
+    }),
+  );
+
   return {
     mode: isDev ? 'development' : 'production',
     profile: false,

packages/cli/src/lib/bundler/server.ts

@@ -30,7 +30,7 @@ export async function serveBundle(options: ServeOptions) {
   const paths = resolveBundlingPaths(options);
   const pkgPath = paths.targetPackageJson;
   const pkg = await fs.readJson(pkgPath);
-  const config = createConfig(paths, {
+  const config = await createConfig(paths, {
     ...options,
     isDev: true,
     baseUrl: url,