Clean up broken links from validator output on build, refinements to site URL routine

Author: webstackdev

.github/helpers/build-actions.sh

@@ -62,6 +62,7 @@ jobs:
       - name: Vercel build (production)
         env:
           VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
+          NODE_ENV: production
         run: vercel build --prod --token=${VERCEL_TOKEN}
 
       ##

.github/workflows/deployment-production.yml

@@ -55,6 +55,4 @@ Right now we're using string literals to define HTML email templates for site ma
 
 Vercel AI Gateway, maybe could use for a chatbot:
 
-Vercel AI Gateway, maybe could use for a chatbot:
-
 https://vercel.com/kevin-browns-projects-dd474f73/astro-webstackbuilders-com/ai-gateway

_TODO.md

@@ -1,7 +1,6 @@
 import AstroPWA from '@vite-pwa/astro'
 import db from '@astrojs/db'
 import icon from 'astro-icon'
-import linkValidator from 'astro-link-validator'
 import lit from '@semantic-ui/astro-lit'
 import mdx from '@astrojs/mdx'
 import sentry from '@sentry/astro'
@@ -25,9 +24,11 @@ import {
   environmentalVariablesConfig,
   getSentryAuthToken,
   getSiteUrl,
-  isGitHub,
+  isDev,
+  isProd,
   isUnitTest,
   isVercel,
+  linkValidatorPlugin,
   markdownConfig,
   pwaConfig,
   vercelConfig,
@@ -76,12 +77,12 @@ const standardIntegrations = [
       exclude: ['downloads', '/articles/demo', 'testing'],
     }),
   }),
-  /** Validate links in built site output on astro:build:done integration hook */
-  linkValidator({
-    checkExternal: isGitHub(),
-    failOnBrokenLinks: false,
-    verbose: true,
-  }),
+  /**
+   * Validate links in built site output on astro:build:done integration hook. Ran locally
+   * and on GitHub production builds because links can't be determined at build time in
+   * GitHub preview environments.
+   */
+  ...(isDev() || isProd() ? [linkValidatorPlugin] : []),
   /** Integration to write pages.json after build so E2E tests can discover what pages exist */
   pagesJsonWriter(),
   /** Debugging tools for Astro View Transition API */

astro.config.ts

@@ -29,9 +29,8 @@
     "servers/*"
   ],
   "scripts": {
-    "build:action": "FORCE_COLOR=1 bash .github/helpers/build-actions.sh",
     "build": "cross-env NODE_ENV=production npx astro build --remote",
-    "build:ci": "cross-env npm run build",
+    "build:ci": "cross-env NODE_ENV=production npx astro build",
     "check": "npx astro check",
     "clean": "FORCE_COLOR=1 npx rimraf dist && FORCE_COLOR=1 npx rimraf .astro",
     "containers:down": "FORCE_COLOR=1 docker compose --env-file test/containers/.env -f test/containers/docker-compose.e2e.yml down -v",

package.json

@@ -151,7 +151,7 @@ const year = new Date().getFullYear()
         {/* Page footer RSS link */}
         <span class:list={[styles.footerFeedIcon, 'flex items-center w-12 lg:h-12 lg:w-12']}>
           <a
-            href={`${getSiteUrl()}/feed.xml`}
+            href={`${getSiteUrl()}/rss.xml`}
             title="RSS Feed"
             class="text-text [&_.icon]:fill-text! [&_.icon]:stroke-text! [&_.icon]:h-10 [&_.icon]:w-10 hover:[&_.icon]:fill-secondary! hover:[&_.icon]:stroke-secondary! focus:[&_.icon]:fill-secondary! focus:[&_.icon]:stroke-secondary! focus:outline-none"
           >
@@ -178,7 +178,7 @@ const year = new Date().getFullYear()
       {/* Page footer RSS link */}
       <span class:list={[styles.footerFeedIcon, 'flex items-center w-12 lg:h-12 lg:w-12']}>
         <a
-          href={`${getSiteUrl()}/feed.xml`}
+          href={`${getSiteUrl()}/rss.xml`}
           title="RSS Feed"
           class="text-text [&_.icon]:fill-text! [&_.icon]:stroke-text! [&_.icon]:h-10 [&_.icon]:w-10 hover:[&_.icon]:fill-secondary! hover:[&_.icon]:stroke-secondary! focus:[&_.icon]:fill-secondary! focus:[&_.icon]:stroke-secondary! focus:outline-none"
         >

src/components/Footer/index.astro

@@ -31,11 +31,11 @@ export const isCI = () => {
 }
 
 export const isDev = () => {
-  return !isVercel()
+  return !isVercel() && !isGitHub()
 }
 
 export const isProd = () => {
-  return isVercel()
+  return isVercel() || process.env['NODE_ENV'] === 'production'
 }
 
 /**

src/lib/config/environmentServer.ts

@@ -11,6 +11,7 @@ export {
   isVercel,
 } from './environmentServer'
 export { getSiteUrl } from './siteUrlServer'
+export { linkValidatorPlugin } from './linkValidator'
 export { markdownConfig } from './markdown'
 export { pwaConfig } from './pwa'
 export { vercelConfig } from './vercel'

src/lib/config/index.ts

@@ -0,0 +1,29 @@
+import linkValidator from 'astro-link-validator'
+
+export const linkValidatorPlugin = linkValidator({
+  checkExternal: true,
+  exclude: [
+    /**
+     * Company social network links are manually maintained, rated
+     * limited in CI so hard to check automatically
+     */
+    'https://bsky.app/profile/webstackdev.bsky.social',
+    'https://codepen.io/webstackdev',
+    'https://github.com/webstackdev',
+    'https://k8s.social/@webstackdev',
+    'https://webmention.io/www.webstackbuilders.com',
+    'https://www.facebook.com/webstackbuilders',
+    'https://www.instagram.com/webstackbuilders/',
+    'https://www.linkedin.com/company/webstack-builders',
+    'https://www.youtube.com/@webstackbuilders',
+    'https://x.com/WebstackDev',
+    /** Requires HEAD request, not GET */
+    'https://outlook.office.com/calendar/0/deeplink/compose',
+    /** Rate-limited URLs that will always fail */
+    'https://www.npmjs.com',
+    /** Dummy link in demo page */
+    '/path/to#my-blob',
+  ],
+  failOnBrokenLinks: false,
+  verbose: true,
+})

src/lib/config/linkValidator.ts

@@ -2,7 +2,10 @@
  * Server-side method to determine correct URL
  */
 import { BuildError } from '../errors/BuildError'
-import { isVercel } from './environmentServer'
+import {
+  isProd,
+  isVercel
+} from './environmentServer'
 
 const devServerPort = process.env['DEV_SERVER_PORT']?.trim()
 const resolvedDevServerPort = devServerPort && devServerPort.length > 0 ? devServerPort : '4321'
@@ -17,5 +20,9 @@ export const getSiteUrl = (): string => {
     )
   }
 
+  if (isProd()) {
+    return 'https://www.webstackbuilders.com'
+  }
+
   return `http://localhost:${resolvedDevServerPort}`
 }