build(ui-alerts,console): make documentation preview builds show console logs

INSTUI-4522

Author: ToMESSKa

.github/workflows/preview.yml

@@ -24,6 +24,9 @@ jobs:
       - name: Build docs-app
         run: npm run build:docs
         if: github.event.action != 'closed'
+        env: # ← ADD THIS SECTION ←
+          IS_PREVIEW: 'true'
+          NODE_ENV: 'production'
       - uses: rossjrw/pr-preview-action@v1
         with:
           source-dir: ./packages/__docs__/__build__

packages/__docs__/webpack.config.mjs

@@ -79,6 +79,11 @@ const config = merge(baseConfig, {
       template: './src/index.html',
       chunks: ['main'],
     }),
+    new webpack.DefinePlugin({
+      'process.env.NODE_ENV': JSON.stringify(ENV),
+      'process.env.IS_PREVIEW': JSON.stringify(IS_PREVIEW),
+      'process.env.DEBUG': JSON.stringify(DEBUG),
+    }),
   ],
   optimization: {
     usedExports: true,

packages/console/src/console.ts

@@ -55,7 +55,18 @@ function logMessage(
   message: string,
   ...args: unknown[]
 ) {
-  if (process.env.NODE_ENV !== 'production' && !condition) {
+  const isGitHubPreview =
+    process.env.GITHUB_ACTIONS === 'true' &&
+    process.env.GITHUB_EVENT_NAME === 'pull_request'
+
+  // const shouldShowLogs =
+  //   process.env.NODE_ENV !== 'production' ||
+  //   isGitHubPreview ||
+  //   process.env.IS_PREVIEW === 'true'
+
+  console.log(process.env.IS_PREVIEW, 'is it true')
+
+  if (isGitHubPreview && !condition) {
     if (typeof console[level] === 'function') {
       const renderStack = withRenderStack ? getRenderStack() : ''
       //@ts-expect-error level can be 'constructor' which is not callable

packages/ui-alerts/src/Alert/index.tsx

@@ -43,6 +43,7 @@ import {
 } from '@instructure/ui-icons'
 import { Transition } from '@instructure/ui-motion'
 import { logError as error } from '@instructure/console'
+import { logWarn as warn } from '@instructure/console'
 import { withStyle } from '@instructure/emotion'
 
 import generateStyle from './styles'
@@ -308,6 +309,7 @@ class Alert extends Component<AlertProps, AlertState> {
   }
 
   render() {
+    warn(false, 'I am Dorka')
     const liveRegion = this.getLiveRegion()
     const screenReaderContent = liveRegion
       ? this.createScreenReaderPortal(liveRegion)