Skip to content

Comments

docs: upgrade Starlight to 0.37 and Astro to 5.17#510

Merged
yjose merged 1 commit intomasterfrom
docs/upgrade-starlight-0.37
Feb 4, 2026
Merged

docs: upgrade Starlight to 0.37 and Astro to 5.17#510
yjose merged 1 commit intomasterfrom
docs/upgrade-starlight-0.37

Conversation

@yjose
Copy link
Member

@yjose yjose commented Feb 4, 2026

Summary

  • Upgrade @astrojs/starlight from 0.31 to 0.37.6 and astro from 5.1 to 5.17.1 (latest stable, stays on v5 — Astro 6 is still beta)
  • Migrate all breaking changes introduced between Starlight 0.31 and 0.37
  • Remove sharp and switch to passthroughImageService — no image optimization was actually in use
  • Fix a pre-existing broken <CodeBlock> reference to a deleted workflow file

Breaking changes addressed

Version Change Migration
0.32 Route data moved from Astro.props to Astro.locals.starlightRoute Updated LastUpdated.astro component override
0.33 social config changed from object shorthand to explicit array Updated astro.config.mjs
0.30+ Content collections moved to the Content Layer API Replaced src/content/config.ts with src/content.config.ts using docsLoader/i18nLoader
0.34 CSS cascade layers — built-in styles now in a starlight layer No code change needed; custom CSS auto-overrides

Other changes

  • Removed unused pluginLineNumbers import and deleted ec.config.mjs (both expressive-code plugins were commented out)
  • Added vite.ssr.noExternal: ['zod'] to prevent the root project's zod@4 from leaking into the Starlight build
  • Fixed workflows-references.mdx: eas-build-qa.ymleas-build-preview.yml (the QA workflow file no longer exists)

Test plan

  • pnpm build inside docs/ exits cleanly (31 pages built)
  • Browse the deployed preview — verify homepage hero, sidebar nav, code blocks with syntax themes, and card grids render correctly
  • Check that the GitHub social link appears in the header
  • Verify at least one page shows the "Last updated" date and Giscus comments section

- Upgrade @astrojs/starlight from 0.31 to 0.37.6 and astro from 5.1 to 5.17.1
- Migrate social config to the new array-based format (breaking in 0.33)
- Migrate content collections to the Content Layer API using docsLoader and i18nLoader
- Update LastUpdated component to read from Astro.locals.starlightRoute (breaking in 0.32)
- Switch to passthroughImageService and remove sharp — no image optimization was in use
- Remove dead pluginLineNumbers import and ec.config.mjs (plugins were commented out)
- Fix broken CodeBlock reference to eas-build-qa.yml → eas-build-preview.yml
- Add vite.ssr.noExternal for zod to prevent conflict with root project zod v4
@netlify
Copy link

netlify bot commented Feb 4, 2026

Deploy Preview for obytes-starter ready!

Name Link
🔨 Latest commit 50d457b
🔍 Latest deploy log https://app.netlify.com/projects/obytes-starter/deploys/69837d40bf70c500086076d7
😎 Deploy Preview https://deploy-preview-510--obytes-starter.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

💯 Test Coverage

Lines Statements Branches Functions
Coverage: 31%
30.64% (129/421) 35.04% (82/234) 26.94% (52/193)

😎 Tests Results

Tests Skipped Failures Errors Time
40 0 💤 0 ❌ 0 🔥 19.47s ⏱️
👀 Tests Details • (31%)
File% Stmts% Branch% Funcs% LinesUncovered Line #s
All files30.6435.0426.9431.34 
report-only-changed-files is enabled. No files were changed in this commit :)

@yjose yjose merged commit a1c845e into master Feb 4, 2026
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant