Skip to content

feat: only add lastmod during prod build #26361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 7, 2025
Merged

feat: only add lastmod during prod build #26361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
add4896
feat: only add lastmod during prod build
colbywhite Nov 6, 2025
78b0ada
refactor: use casing for constant
colbywhite Nov 6, 2025
67354cb
fix: enable on prod builds, not pr-to-prod builds
colbywhite Nov 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/publish-production.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ jobs:
name: Build
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
ENABLE_LAST_MOD_IN_SITEMAP: true
- run: npx wrangler deploy
name: Deploy to Cloudflare Workers
env:
Expand Down
39 changes: 23 additions & 16 deletions astro.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import liveCode from "astro-live-code";
import starlightLinksValidator from "starlight-links-validator";
import starlightScrollToTop from "starlight-scroll-to-top";
import icon from "astro-icon";
import sitemap from "@astrojs/sitemap";
import sitemap, { type SitemapItem } from "@astrojs/sitemap";
import react from "@astrojs/react";

import { readdir } from "fs/promises";
Expand Down Expand Up @@ -59,7 +59,10 @@ async function autogenStyles() {
const sidebar = await autogenSections();
const customCss = await autogenStyles();

const runLinkCheck = process.env.RUN_LINK_CHECK || false;
const RUN_LINK_CHECK =
process.env.RUN_LINK_CHECK?.toLowerCase() === "true" || false;
const ENABLE_LAST_MOD_IN_SITEMAP =
process.env.ENABLE_LAST_MOD_IN_SITEMAP?.toLowerCase() === "true";

/**
* Get the last Git modification date for a file
Expand Down Expand Up @@ -107,6 +110,22 @@ function urlToFilePath(url: string): string | null {
}
}

function addLastModDate(item: SitemapItem) {
const filePath = urlToFilePath(item.url);
if (filePath) {
const gitDate = getGitLastModified(filePath);
if (gitDate) {
item.lastmod = gitDate;
}
} else {
console.warn(
`[sitemap] Could not find last modified for ${item.url} - setting to now`,
);
item.lastmod = new Date().toISOString();
}
return item;
}

// https://astro.build/config
export default defineConfig({
site: "https://developers.cloudflare.com",
Expand Down Expand Up @@ -176,7 +195,7 @@ export default defineConfig({
customCss,
pagination: false,
plugins: [
...(runLinkCheck
...(RUN_LINK_CHECK
? [
starlightLinksValidator({
errorOnInvalidHashes: false,
Expand Down Expand Up @@ -242,19 +261,7 @@ export default defineConfig({
return true;
},
serialize(item) {
const filePath = urlToFilePath(item.url);
if (filePath) {
const gitDate = getGitLastModified(filePath);
if (gitDate) {
item.lastmod = gitDate;
}
} else {
console.warn(
`[sitemap] Could not find last modified for ${item.url} - setting to now`,
);
item.lastmod = new Date().toISOString();
}
return item;
return ENABLE_LAST_MOD_IN_SITEMAP ? addLastModDate(item) : item;
},
}),
react(),
Expand Down
Loading